00001 /* vim: set sw=4 sts=4 et foldmethod=syntax : */ 00002 00003 /* 00004 * Copyright (c) 2006, 2007 Ciaran McCreesh 00005 * Copyright (c) 2009 David Leverton 00006 * 00007 * This file is part of the Paludis package manager. Paludis is free software; 00008 * you can redistribute it and/or modify it under the terms of the GNU General 00009 * Public License version 2, as published by the Free Software Foundation. 00010 * 00011 * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY 00012 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 00013 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 00014 * details. 00015 * 00016 * You should have received a copy of the GNU General Public License along with 00017 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple 00018 * Place, Suite 330, Boston, MA 02111-1307 USA 00019 */ 00020 00021 #ifndef PALUDIS_GUARD_PALUDIS_UTIL_PTY_HH 00022 #define PALUDIS_GUARD_PALUDIS_UTIL_PTY_HH 1 00023 00024 #include <paludis/util/channel.hh> 00025 #include <paludis/util/exception.hh> 00026 00027 /** \file 00028 * Declaration for the Pty class. 00029 * 00030 * \ingroup g_system 00031 * 00032 * \section Examples 00033 * 00034 * - None at this time. 00035 */ 00036 00037 namespace paludis 00038 { 00039 /** 00040 * Thrown if a pty cannot be allocated and opened. 00041 * 00042 * \ingroup g_exceptions 00043 * \ingroup g_system 00044 * \nosubgrouping 00045 */ 00046 class PALUDIS_VISIBLE PtyError : 00047 public Exception 00048 { 00049 public: 00050 ///\name Basic operations 00051 ///\{ 00052 00053 PtyError(const std::string & message) throw (); 00054 00055 ///\} 00056 }; 00057 00058 /** 00059 * Wrapper around pty file descriptors. 00060 * 00061 * \ingroup g_system 00062 * \nosubgrouping 00063 */ 00064 class PALUDIS_VISIBLE Pty : 00065 public Channel 00066 { 00067 public: 00068 ///\name Basic operations 00069 ///\{ 00070 00071 Pty(); 00072 00073 virtual ~Pty(); 00074 00075 ///\} 00076 00077 }; 00078 00079 } 00080 00081 #endif