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    
020    package org.crsh.term;
021    
022    import org.crsh.io.Pipe;
023    import org.crsh.text.Chunk;
024    
025    import java.io.Closeable;
026    import java.io.IOException;
027    
028    public interface Term extends Closeable, Pipe<Chunk> {
029    
030      /**
031       * Returns the term width in chars. When the value is not positive it means the value could not be determined.
032       *
033       * @return the term width
034       */
035      int getWidth();
036    
037      /**
038       * Returns the term height in chars. When the value is not positive it means the value could not be determined.
039       *
040       * @return the term height
041       */
042      int getHeight();
043    
044      /**
045       * Retrieves the value of a property specified by this Term
046       *
047       * @param name name of the term property
048       * @return value of the term property
049       */
050      String getProperty(String name);
051    
052      /**
053       * Set the echo mode on the term.
054       *
055       * @param echo the echo mode
056       */
057      void setEcho(boolean echo);
058    
059      /**
060       * Read the next term event. This operation is a blocking operation that blocks until data is available or until
061       * term is closed.
062       *
063       * @return the next term event
064       * @throws IOException any io exception
065       */
066      TermEvent read() throws IOException;
067    
068      /**
069       * Returns the insert buffer, any char appended in the returned appendable will translate into an
070       * insertion in the buffer.
071       *
072       * @return the insert buffer.
073       */
074      Appendable getInsertBuffer();
075    
076      /**
077       * Returns the current buffer content to the cursor;
078       *
079       * @return the buffer
080       */
081      CharSequence getBuffer();
082    
083      /**
084       * Append a line to the term history.
085       *
086       * @param line the history line to append
087       */
088      void addToHistory(CharSequence line);
089    
090      /**
091       * Flush the term buffer.
092       */
093      void flush();
094    
095      /**
096       * Close the term. If threads are blocked in the {@link #read()} operation, those thread should be unblocked.
097       */
098      void close();
099    
100      /**
101       * Returns the class of the consumed type.
102       *
103       * @return the consumed type
104       */
105      Class<Chunk> getConsumedType();
106    }