// -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 2 -*- /* Copyright (C) 2007 The gtkmm Development Team * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ #include #include #include #include #include _DEFS(giomm,gio) _PINCLUDE(giomm/private/outputstream_p.h) namespace Gio { /** FileOutputStream provides output streams that write their content to a file. * * FileOutputStream implements Seekable, which allows the output stream to jump * to arbitrary positions in the file and to truncate the file, provided the * file system of the file supports these operations. * Use the methods of the Seekable base class for seeking and positioning. * * @ingroup Streams * * @newin2p16 */ class FileOutputStream : public OutputStream, public Seekable { _CLASS_GOBJECT(FileOutputStream, GFileOutputStream, G_FILE_OUTPUT_STREAM, Gio::OutputStream, GOutputStream) _IMPLEMENTS_INTERFACE(Seekable) public: /** Queries a file output stream for the given @a attributes . * This function blocks while querying the stream. For the asynchronous * version of this function, see query_info_async(). * While the stream is blocked, the stream will set the pending flag * internally, and any other operations on the stream will throw a Gio::Error with * PENDING. * * Can fail if the stream was already closed (with a * CLOSED error), the stream has pending operations (with a PENDING error), * or if querying info is not supported for * the stream's interface (with a NOT_SUPPORTED error). In * all cases of failure, an empty RefPtr will be returned. * * The operation can be cancelled by triggering the cancellable object from another thread. If the operation * was cancelled, a Gio::Error with CANCELLED may be thrown, and an empty RefPtr will * be returned. * * @param cancellable A Cancellable object. * @param attributes A file attribute query string. * @return A FileInfo for the stream, or an empty RefPtr on error. */ #ifdef GLIBMM_EXCEPTIONS_ENABLED Glib::RefPtr query_info(const Glib::RefPtr& cancellable, const std::string& attributes = "*"); #else Glib::RefPtr query_info(const Glib::RefPtr& cancellable, const std::string& attributes, std::auto_ptr& error); #endif //GLIBMM_EXCEPTIONS_ENABLED /** Queries a file output stream for the given @a attributes . * This function blocks while querying the stream. For the asynchronous * version of this function, see query_info_async(). * While the stream is blocked, the stream will set the pending flag * internally, and any other operations on the stream will throw a Gio::Error with * PENDING. * * Can fail if the stream was already closed (with a CLOSED error), * the stream has pending operations (with an PENDING error), * or if querying info is not supported for * the stream's interface (with a NOT_SUPPORTED error). In * all cases of failure, an empty RefPtr will be returned. * * The operation can be cancelled by triggering the cancellable object from another thread. If the operation * was cancelled, a Gio::Error with CANCELLED may be thrown, and an empty RefPtr will * be returned. * * @param cancellable A Cancellable object. * @param attributes A file attribute query string. * @return A FileInfo for the stream, or an empty RefPtr on error. */ #ifdef GLIBMM_EXCEPTIONS_ENABLED Glib::RefPtr query_info(const std::string& attributes = "*"); #else Glib::RefPtr query_info(const std::string& attributes, std::auto_ptr& error); #endif //GLIBMM_EXCEPTIONS_ENABLED _IGNORE(g_file_output_stream_query_info) /** Queries the stream information asynchronously. * When the operation is finished @a slot will be called. * You can then call query_info_finish() * to get the result of the operation. * * For the synchronous version of this function, * see query_info(). * * If @a cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation * was cancelled, a Gio::Error with CANCELLED may be thrown * * @param slot Callback to call when the request is satisfied. * @param cancellable A Cancellable object. * @param attributes A file attribute query string. * @param io_priority The & cancellable, const std::string& attributes = "*", int io_priority = Glib::PRIORITY_DEFAULT); /** Queries the stream information asynchronously. * When the operation is finished @a slot will be called. * You can then call query_info_finish() * to get the result of the operation. * * For the synchronous version of this function, * see query_info(). * * @param slot Callback to call when the request is satisfied. * @param attributes A file attribute query string. * @param io_priority The query_info_finish(const Glib::RefPtr& result), g_file_output_stream_query_info_finish, refreturn, errthrow) _WRAP_METHOD(std::string get_etag() const, g_file_output_stream_get_etag) //These seem to be just C convenience functions - they are already in the Seekable base class: //See http://bugzilla.gnome.org/show_bug.cgi?id=509990 _IGNORE(g_file_output_stream_tell, g_file_output_stream_can_seek, g_file_output_stream_seek, g_file_output_stream_can_truncate, g_file_output_stream_truncate) // _WRAP_METHOD(goffset tell() const, g_file_output_stream_tell) // _WRAP_METHOD(bool can_seek() const, g_file_output_stream_can_seek) // _WRAP_METHOD(bool seek(goffset offset, Glib::SeekType type, const Glib::RefPtr& cancellable), // g_file_output_stream_seek, // errthrow) // _WRAP_METHOD(bool can_truncate() const, g_file_output_stream_can_truncate) // _WRAP_METHOD(bool truncate(goffset size, const Glib::RefPtr& cancellable), // g_file_output_stream_truncate, // errthrow) }; } // namespace Gio