diff options
106 files changed, 964 insertions, 955 deletions
@@ -1,3 +1,12 @@ +2012-10-29 Mark Vender <markv743@yahoo.co.uk> + + Strip trailing whitespace. + + * gio/giomm/*.[h|cc]: + * gio/src/*.[hg|ccg]: + * glib/glibmm/*.[h|cc]: + * glib/src/*.[hg|ccg]: Strip trailing whitespace. Bug #681072. + 2012-10-25 José Alburquerque <jaalburquerque@gmail.com> ContentType: Fix typo in the content_type_get_symbolic_icon() name. diff --git a/gio/giomm/contenttype.h b/gio/giomm/contenttype.h index e6ce3cbc..af27f24f 100644 --- a/gio/giomm/contenttype.h +++ b/gio/giomm/contenttype.h @@ -130,7 +130,7 @@ Glib::ustring content_type_from_mime_type(const Glib::ustring& mime_type); * given data. */ Glib::ustring content_type_guess(const std::string& filename, - const guchar* data, gsize data_size, + const guchar* data, gsize data_size, bool& result_uncertain); /** @@ -144,7 +144,7 @@ Glib::ustring content_type_guess(const std::string& filename, * given data. */ Glib::ustring content_type_guess(const std::string& filename, - const std::string& data, + const std::string& data, bool& result_uncertain); /** Tries to guess the type of the tree with root @a root, by @@ -152,7 +152,7 @@ Glib::ustring content_type_guess(const std::string& filename, * of content types, with the best guess coming first. * * The types returned all have the form x-content/foo, e.g. - * x-content/audio-cdda (for audio CDs) or x-content/image-dcf + * x-content/audio-cdda (for audio CDs) or x-content/image-dcf * (for a camera memory card). See the <ulink url="http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec">shared-mime-info</ulink> * specification for more on x-content types. * diff --git a/gio/giomm/init.cc b/gio/giomm/init.cc index c3e7e122..df20dba0 100644 --- a/gio/giomm/init.cc +++ b/gio/giomm/init.cc @@ -1,5 +1,5 @@ /* init.cc - * + * * Copyright (C) 2007 The gtkmm team * * This library is free software; you can redistribute it and/or diff --git a/gio/giomm/init.h b/gio/giomm/init.h index 08fde96f..c8804044 100644 --- a/gio/giomm/init.h +++ b/gio/giomm/init.h @@ -5,7 +5,7 @@ #include "wrap_init.h" /* init.h - * + * * Copyright (C) 2007 The gtkmm development team * * This library is free software; you can redistribute it and/or diff --git a/gio/giomm/wrap_init.h b/gio/giomm/wrap_init.h index 2c0ac019..c86ee49f 100644 --- a/gio/giomm/wrap_init.h +++ b/gio/giomm/wrap_init.h @@ -3,7 +3,7 @@ #define _GIOMM_WRAP_INIT_H /* wrap_init.h - * + * * Copyright (C) 2007 The gtkmm development team * * This library is free software; you can redistribute it and/or diff --git a/gio/src/appinfo.ccg b/gio/src/appinfo.ccg index fc8d0183..84d96b7a 100644 --- a/gio/src/appinfo.ccg +++ b/gio/src/appinfo.ccg @@ -59,7 +59,7 @@ bool AppInfo::launch(const Glib::RefPtr<Gio::File>& file, const Glib::RefPtr<App { std::vector< Glib::RefPtr<Gio::File> > vec; vec.push_back(file); - + GError* gerror = 0; bool retvalue = g_app_info_launch(gobj(), Glib::ListHandler<Glib::RefPtr<Gio::File> >::vector_to_list(vec).data (), Glib::unwrap(launch_context), &(gerror)); if(gerror) @@ -72,7 +72,7 @@ bool AppInfo::launch(const Glib::RefPtr<Gio::File>& file) { std::vector< Glib::RefPtr<Gio::File> > vec; vec.push_back(file); - + GError* gerror = 0; bool retvalue = g_app_info_launch(gobj(), Glib::ListHandler<Glib::RefPtr<Gio::File> >::vector_to_list(vec).data (), 0, &(gerror)); if(gerror) @@ -85,7 +85,7 @@ bool AppInfo::launch_uri(const std::string& uri, const Glib::RefPtr<AppLaunchCon { std::vector<std::string> vec; vec.push_back(uri); - + GError* gerror = 0; bool retvalue = g_app_info_launch_uris(gobj(), Glib::ListHandler<std::string>::vector_to_list(vec).data (), Glib::unwrap(launch_context), &(gerror)); if(gerror) @@ -98,7 +98,7 @@ bool AppInfo::launch_uri(const std::string& uri) { std::vector<std::string> vec; vec.push_back(uri); - + GError* gerror = 0; bool retvalue = g_app_info_launch_uris(gobj(), Glib::ListHandler<std::string>::vector_to_list(vec).data (), 0, &(gerror)); if(gerror) diff --git a/gio/src/appinfo.hg b/gio/src/appinfo.hg index ecbf5987..e4a35e6d 100644 --- a/gio/src/appinfo.hg +++ b/gio/src/appinfo.hg @@ -45,7 +45,7 @@ _WRAP_ENUM(AppInfoCreateFlags, GAppInfoCreateFlags, NO_GTYPE) class File; -/** Application information, to describe applications installed on the system, +/** Application information, to describe applications installed on the system, * and launch them. * See also AppLaunchContext. * @@ -84,16 +84,16 @@ public: * as an argument, using the optional @a launch_context to get information * about the details of the launcher (like what screen it is on). * On error, an exception will be thrown accordingly. - * + * * Note that even if the launch is successful the application launched * can fail to start if it runs into problems during startup. There is * no way to detect this. - * + * * Some URIs can be changed when passed through a GFile (for instance * unsupported uris with strange formats like mailto:), so if you have * a textual uri you want to pass in as argument, consider using * launch_uris() instead. - * + * * On UNIX, this function sets the <envar>GIO_LAUNCHED_DESKTOP_FILE</envar> * environment variable with the path of the launched desktop file and * <envar>GIO_LAUNCHED_DESKTOP_FILE_PID</envar> to the process @@ -109,20 +109,20 @@ public: * @newin{3,2} */ bool launch(const Glib::RefPtr<Gio::File>& file, const Glib::RefPtr<AppLaunchContext>& launch_context); - + /** Launches the application. This passes the @a file to the launched application * as an arguments. * On error, an exception will be thrown accordingly. - * + * * Note that even if the launch is successful the application launched * can fail to start if it runs into problems during startup. There is * no way to detect this. - * + * * Some URIs can be changed when passed through a GFile (for instance * unsupported uris with strange formats like mailto:), so if you have * a textual uri you want to pass in as argument, consider using * launch_uris() instead. - * + * * On UNIX, this function sets the <envar>GIO_LAUNCHED_DESKTOP_FILE</envar> * environment variable with the path of the launched desktop file and * <envar>GIO_LAUNCHED_DESKTOP_FILE_PID</envar> to the process @@ -137,7 +137,7 @@ public: * @newin{3,2} */ bool launch(const Glib::RefPtr<Gio::File>& file); - + _WRAP_METHOD(bool launch(const std::vector< Glib::RefPtr<Gio::File> >& files, const Glib::RefPtr<AppLaunchContext>& launch_context{?}), g_app_info_launch, @@ -157,12 +157,12 @@ public: const Glib::RefPtr<AppLaunchContext>& launch_context{?}), g_app_info_launch_uris, errthrow) - + /** Launches the application. This passes the @a uri to the launched application * as an arguments, using the optional @a launch_context to get information * about the details of the launcher (like what screen it is on). * On error, an exception will be thrown accordingly. - * + * * Note that even if the launch is successful the application launched * can fail to start if it runs into problems during startup. There is * no way to detect this. @@ -179,7 +179,7 @@ public: * @newin{3,2} */ bool launch_uri(const std::string& uris); - + _WRAP_METHOD(bool should_show() const, g_app_info_should_show) // FIXME: use better terminology than delete/do_delete _WRAP_METHOD(bool can_delete() const, g_app_info_can_delete) diff --git a/gio/src/application.ccg b/gio/src/application.ccg index f11e4543..3dee00d6 100644 --- a/gio/src/application.ccg +++ b/gio/src/application.ccg @@ -25,7 +25,7 @@ namespace { -static void Application_signal_open_callback(GApplication* self, GFile** files, +static void Application_signal_open_callback(GApplication* self, GFile** files, gint n_files, const gchar* hint, void* data) { typedef sigc::slot< void, const Gio::Application::type_vec_files&, const Glib::ustring& > SlotType; @@ -35,7 +35,7 @@ static void Application_signal_open_callback(GApplication* self, GFile** files, { vec_files[i] = Glib::wrap(files[i], true); } - + const Glib::ustring hint_str = (hint ? hint : Glib::ustring()); // Do not try to call a signal on a disassociated wrapper. @@ -68,7 +68,7 @@ static void Application_signal_open_notify_callback(GApplication* self, GFile** { vec_files[i] = Glib::wrap(files[i], true); } - + const Glib::ustring hint_str = (hint ? hint : Glib::ustring()); // Do not try to call a signal on a disassociated wrapper. @@ -118,7 +118,7 @@ Application::Application(const Glib::ustring& application_id, ApplicationFlags f Glib::ObjectBase(0), Glib::Object(Glib::ConstructParams(custom_class_init(), "application_id", (application_id.empty() ? 0 : application_id.c_str()), "flags", ((GApplicationFlags)(flags)), static_cast<char*>(0))) { - + } //static @@ -127,7 +127,7 @@ void Application::unset_default() g_application_set_default(0); } -void Application_Class::open_callback(GApplication* self, GFile** files, +void Application_Class::open_callback(GApplication* self, GFile** files, gint n_files, const gchar *hint) { Glib::ObjectBase *const obj_base = static_cast<Glib::ObjectBase*>( @@ -151,9 +151,9 @@ void Application_Class::open_callback(GApplication* self, GFile** files, for (int i = 0; i < n_files; i++) { vec_files[i] = Glib::wrap(files[i], true); } - + const Glib::ustring hint_str = (hint ? hint : Glib::ustring()); - + obj->on_open(vec_files, hint_str); return; } @@ -163,7 +163,7 @@ void Application_Class::open_callback(GApplication* self, GFile** files, } } } - + BaseClassType *const base = static_cast<BaseClassType*>( g_type_class_peek_parent(G_OBJECT_GET_CLASS(self)) // Get the parent class of the object class (The original underlying C class). ); @@ -185,7 +185,7 @@ void Gio::Application::on_open(const Application::type_vec_files& files, const G ); if(base && base->open) { - (*base->open)(gobj(), + (*base->open)(gobj(), Glib::ArrayHandler<type_vec_files::value_type>::vector_to_array(files).data(), files.size(), hint.c_str()); @@ -194,7 +194,7 @@ void Gio::Application::on_open(const Application::type_vec_files& files, const G void Application::open(const type_vec_files& files, const Glib::ustring& hint) { - g_application_open(gobj(), + g_application_open(gobj(), Glib::ArrayHandler<type_vec_files::value_type>::vector_to_array(files).data(), files.size(), hint.c_str()); diff --git a/gio/src/application.hg b/gio/src/application.hg index 093d7b76..d10f8a54 100644 --- a/gio/src/application.hg +++ b/gio/src/application.hg @@ -159,7 +159,7 @@ public: */ void open(const type_vec_files& files, const Glib::ustring& hint = Glib::ustring()); _IGNORE(g_application_open) - + /* Opens the given file. * * In essence, this results in the open signal being emitted @@ -202,7 +202,7 @@ public: _WRAP_SIGNAL(void startup(), "startup") _WRAP_SIGNAL(void activate(), "activate") - + //We wrap the open signal without _WRAP_SIGNAL(), because we need to change its parameters. //See bug https://bugzilla.gnome.org/show_bug.cgi?id=637457 Glib::SignalProxy2< void, const type_vec_files&, const Glib::ustring& > signal_open(); @@ -225,7 +225,7 @@ protected: #m4 _CONVERSION(`char**&', `gchar***',`&($3)') #m4 _CONVERSION(`gchar***', `char**&',`*($3)') _WRAP_VFUNC(bool local_command_line(char**& arguments, int& exit_status), local_command_line) - + #m4 _CONVERSION(`GVariant*',`const Glib::VariantBase&',`Glib::wrap($3,true)') _WRAP_VFUNC(void before_emit(const Glib::VariantBase& platform_data), "before_emit") @@ -240,7 +240,7 @@ protected: private: /** This is just a way to call Glib::init() (which calls g_type_init()) before - * calling application_class_.init(), so that + * calling application_class_.init(), so that * g_application_get_type() will always succeed. * See https://bugzilla.gnome.org/show_bug.cgi?id=639925 */ diff --git a/gio/src/applicationcommandline.ccg b/gio/src/applicationcommandline.ccg index 8cc2b062..1e16f2de 100644 --- a/gio/src/applicationcommandline.ccg +++ b/gio/src/applicationcommandline.ccg @@ -14,7 +14,7 @@ * License along with this library; if not, write to the Free * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ - + #include <gio/gio.h> #include <glibmm/vectorutils.h> @@ -23,12 +23,12 @@ namespace Gio void ApplicationCommandLine::print(const Glib::ustring& message) { - g_application_command_line_print(gobj(), "%s", message.c_str()); + g_application_command_line_print(gobj(), "%s", message.c_str()); } void ApplicationCommandLine::printerr(const Glib::ustring& message) { - g_application_command_line_printerr(gobj(), "%s", message.c_str()); + g_application_command_line_printerr(gobj(), "%s", message.c_str()); } } //namespace Gio diff --git a/gio/src/applicationcommandline.hg b/gio/src/applicationcommandline.hg index 9ec31fec..c8311b13 100644 --- a/gio/src/applicationcommandline.hg +++ b/gio/src/applicationcommandline.hg @@ -62,25 +62,25 @@ protected: public: _WRAP_METHOD(char** get_arguments(int& argc) const, g_application_command_line_get_arguments) - + //We use std::string instead of ustring because the C documentation says that it may be non-UTF-8 data: _WRAP_METHOD(std::string get_cwd() const, g_application_command_line_get_cwd) //We use std::string instead of ustring because the C documentation says that it may be non-UTF-8 data: #m4 _CONVERSION(`const gchar* const*',`std::vector<std::string>',`Glib::ArrayHandler<std::string>::array_to_vector($3, Glib::OWNERSHIP_NONE)') _WRAP_METHOD(std::vector<std::string> get_environ() const, g_application_command_line_get_environ) - + //We use std::string instead of ustring because the C documentation says that it may be non-UTF-8 data: _WRAP_METHOD(std::string getenv(const Glib::ustring& name) const, g_application_command_line_getenv) - + _WRAP_METHOD(bool is_remote() const, g_application_command_line_get_is_remote) #m4 _CONVERSION(`GVariant*',`Glib::Variant< std::map<Glib::ustring, Glib::VariantBase> >',`$2($3)') _WRAP_METHOD(Glib::Variant< std::map<Glib::ustring, Glib::VariantBase> > get_platform_data() const, g_application_command_line_get_platform_data) - + _WRAP_METHOD(void set_exit_status(int exit_status), g_application_command_line_set_exit_status) _WRAP_METHOD(int get_exit_status() const, g_application_command_line_get_exit_status) - + /** Formats a message and prints it using the stdout print handler in the invoking process. * If this is a local invocation then this is exactly equivalent to g_print(). * If this is remote then this is equivalent to calling g_print() in the invoking process. @@ -89,7 +89,7 @@ public: */ void print(const Glib::ustring& message); _IGNORE(g_application_command_line_print) - + /** Formats a message and prints it using the stderr print handler in the invoking process. * If this is a local invocation then this is exactly equivalent to g_printerr(). * If this is remote then this is equivalent to calling g_printerr() in the invoking process. diff --git a/gio/src/asyncinitable.ccg b/gio/src/asyncinitable.ccg index 882f780e..6a3c855a 100644 --- a/gio/src/asyncinitable.ccg +++ b/gio/src/asyncinitable.ccg @@ -87,7 +87,7 @@ void AsyncInitable_Class::init_async_vfunc_callback(GAsyncInitable* self, #endif //GLIBMM_EXCEPTIONS_ENABLED } } - + BaseClassType *const base = static_cast<BaseClassType*>( g_type_interface_peek_parent( // Get the parent interface of the interface (The original underlying C interface). g_type_interface_peek(G_OBJECT_GET_CLASS(self), CppObjectType::get_type()) // Get the interface. @@ -144,7 +144,7 @@ gboolean AsyncInitable_Class::init_finish_vfunc_callback(GAsyncInitable* self, #endif //GLIBMM_EXCEPTIONS_ENABLED } } - + BaseClassType *const base = static_cast<BaseClassType*>( g_type_interface_peek_parent( // Get the parent interface of the interface (The original underlying C interface). g_type_interface_peek(G_OBJECT_GET_CLASS(self), CppObjectType::get_type()) // Get the interface. @@ -158,7 +158,7 @@ g_type_interface_peek(G_OBJECT_GET_CLASS(self), CppObjectType::get_type()) // Ge typedef gboolean RType; return RType(); } -bool Gio::AsyncInitable::init_finish_vfunc(const Glib::RefPtr<AsyncResult>& res) +bool Gio::AsyncInitable::init_finish_vfunc(const Glib::RefPtr<AsyncResult>& res) { BaseClassType *const base = static_cast<BaseClassType*>( g_type_interface_peek_parent( // Get the parent interface of the interface (The original underlying C interface). diff --git a/gio/src/asyncinitable.hg b/gio/src/asyncinitable.hg index d12fddfc..c1d8e793 100644 --- a/gio/src/asyncinitable.hg +++ b/gio/src/asyncinitable.hg @@ -46,7 +46,7 @@ class Cancellable; * C applications you generally just call g_async_initable_new_async() * directly, or indirectly via a foo_thing_new_async() wrapper. This will call * g_async_initable_init_async() under the cover, calling back with NULL and a - * set GError on failure. + * set GError on failure. */ class AsyncInitable : public Glib::Interface { @@ -109,7 +109,7 @@ protected: /** @throw Glib::Errror. */ virtual bool init_finish_vfunc(const Glib::RefPtr<AsyncResult>& res); - + protected: #m4begin _PUSH(SECTION_PCC_CLASS_INIT_VFUNCS) diff --git a/gio/src/asyncresult.hg b/gio/src/asyncresult.hg index fa1a809e..133d1859 100644 --- a/gio/src/asyncresult.hg +++ b/gio/src/asyncresult.hg @@ -45,57 +45,57 @@ class AsyncResult; typedef sigc::slot<void, Glib::RefPtr<AsyncResult>& > SlotAsyncReady; /** Provides a base class for implementing asynchronous function results. - * Asynchronous operations are broken up into two separate operations which are chained together by a SlotAsyncReady. - * To begin an asynchronous operation, provide a SlotAsyncReady to the asynchronous function. This callback will be triggered - * when the operation has completed, and will be passed an AsyncResult instance filled with the details of the operation's success or - * failure, the object the asynchronous function was started for and any error codes returned. The asynchronous callback function is then + * Asynchronous operations are broken up into two separate operations which are chained together by a SlotAsyncReady. + * To begin an asynchronous operation, provide a SlotAsyncReady to the asynchronous function. This callback will be triggered + * when the operation has completed, and will be passed an AsyncResult instance filled with the details of the operation's success or + * failure, the object the asynchronous function was started for and any error codes returned. The asynchronous callback function is then * expected to call the corresponding "_finish()" function with the object the function was called for, and the AsyncResult instance. * - * The purpose of the "_finish()" function is to take the generic result of type AsyncResult and return the specific result that the operation - * in question yields (e.g. a FileEnumerator for an "enumerate children" operation). If the result or error status of the operation is not needed, - * there is no need to call the "_finish()" function and GIO will take care of cleaning up the result and error information after the + * The purpose of the "_finish()" function is to take the generic result of type AsyncResult and return the specific result that the operation + * in question yields (e.g. a FileEnumerator for an "enumerate children" operation). If the result or error status of the operation is not needed, + * there is no need to call the "_finish()" function and GIO will take care of cleaning up the result and error information after the * SlotAsyncReady returns. You may also store the AsyncResult and call "_finish()" later. * * Example of a typical asynchronous operation flow: * @code - * void _theoretical_frobnitz_async(const Glib::RefPtr<Theoretical>& t, + * void _theoretical_frobnitz_async(const Glib::RefPtr<Theoretical>& t, * const SlotAsyncReady& slot); - * + * * gboolean _theoretical_frobnitz_finish(const Glib::RefPtr<Theoretical>& t, * const Glib::RefPtr<AsyncResult>& result); - * - * static void + * + * static void * on_frobnitz_result(Glib::RefPtr<AsyncResult>& result) * { - * + * * Glib::RefPtr<Glib::Object> source_object = result->get_source_object(); * bool success = _theoretical_frobnitz_finish(source_object, res); - * + * * if (success) * std::cout << "Hurray" << std::endl; - * else + * else * std::cout << "Uh oh!" << std::endl; - * + * * ... * } - * + * * int main (int argc, void *argv[]) * { * ... - * - * _theoretical_frobnitz_async (theoretical_data, + * + * _theoretical_frobnitz_async (theoretical_data, * sigc::ptr_fun(&on_frobnitz_result) ); - * + * * ... * } * @endcode * * The async function could also take an optional Glib::Cancellable object, allowing the calling function to cancel the asynchronous operation. * - * The callback for an asynchronous operation is called only once, and is always called, even in the case of a cancelled operation. + * The callback for an asynchronous operation is called only once, and is always called, even in the case of a cancelled operation. * On cancellation the result is a ERROR_CANCELLED error. * - * Some ascynchronous operations are implemented using synchronous calls. These are run in a separate GThread, but otherwise they are sent + * Some ascynchronous operations are implemented using synchronous calls. These are run in a separate GThread, but otherwise they are sent * to the Main Event Loop and processed in an idle function. So, if you truly need asynchronous operations, make sure to initialize GThread. * * @newin{2,16} diff --git a/gio/src/bufferedinputstream.hg b/gio/src/bufferedinputstream.hg index 340087ed..d711fb56 100644 --- a/gio/src/bufferedinputstream.hg +++ b/gio/src/bufferedinputstream.hg @@ -27,15 +27,15 @@ namespace Gio { /** @defgroup Streams Stream Classes - * + * */ /** The buffered input stream implements FilterInputStream and provides for buffered reads. - * By default, BufferedInputStream's buffer size is set at 4 kilobytes, but you can specify + * By default, BufferedInputStream's buffer size is set at 4 kilobytes, but you can specify * this to the constructor. - * - * To get the size of a buffer within a buffered input stream, use get_buffer_size(). - * To change the size of a buffered input stream's buffer, use set_buffer_size(). + * + * To get the size of a buffer within a buffered input stream, use get_buffer_size(). + * To change the size of a buffered input stream's buffer, use set_buffer_size(). * Note that the buffer's size cannot be reduced below the size of the data within the buffer. * * @ingroup Streams @@ -47,18 +47,18 @@ class BufferedInputStream : public Gio::FilterInputStream _CLASS_GOBJECT(BufferedInputStream, GBufferedInputStream, G_BUFFERED_INPUT_STREAM, Gio::FilterInputStream, GFilterInputStream) protected: _WRAP_CTOR(BufferedInputStream(const Glib::RefPtr<InputStream>& base_stream), g_buffered_input_stream_new) - + //Note that we rename the size parameter to buffer_size because that is the actual name of the property. _WRAP_CTOR(BufferedInputStream(const Glib::RefPtr<InputStream>& base_stream, gsize buffer_size), g_buffered_input_stream_new_sized) public: - /** Creates a new InputStream from the given base_stream, with a buffer set to the default size (4 kilobytes). + /** Creates a new InputStream from the given base_stream, with a buffer set to the default size (4 kilobytes). * * @param base_stream An InputStream. * @result an InputStream for the given base_stream. */ _WRAP_CREATE(const Glib::RefPtr<InputStream>& base_stream) - + /** Creates a new InputStream from the given base_stream, with a buffer set to size. * * @param base_stream An InputStream. diff --git a/gio/src/bufferedoutputstream.hg b/gio/src/bufferedoutputstream.hg index 3a1ecca7..7d35ca9b 100644 --- a/gio/src/bufferedoutputstream.hg +++ b/gio/src/bufferedoutputstream.hg @@ -27,11 +27,11 @@ namespace Gio { /** The buffered output stream implements FilterOutputStream and provides for buffered writes. - * By default, BufferedOutputStream's buffer size is set at 4 kilobytes, but you + * By default, BufferedOutputStream's buffer size is set at 4 kilobytes, but you * can specify this to the constructor. * - * To get the size of a buffer within a buffered input stream, use get_buffer_size(). - * To change the size of a buffered output stream's buffer, use set_buffer_size(). + * To get the size of a buffer within a buffered input stream, use get_buffer_size(). + * To change the size of a buffered output stream's buffer, use set_buffer_size(). * Note that the buffer's size cannot be reduced below the size of the data within the buffer. * * @ingroup Streams @@ -43,7 +43,7 @@ class BufferedOutputStream : public Gio::FilterOutputStream _CLASS_GOBJECT(BufferedOutputStream, GBufferedOutputStream, G_BUFFERED_OUTPUT_STREAM, Gio::FilterOutputStream, GFilterOutputStream) protected: _WRAP_CTOR(BufferedOutputStream(const Glib::RefPtr<OutputStream>& base_stream), g_buffered_output_stream_new) - + //Note that we rename the size parameter to buffer_size because that is the actual name of the property. _WRAP_CTOR(BufferedOutputStream(const Glib::RefPtr<OutputStream>& base_stream, gsize buffer_size), g_buffered_output_stream_new_sized) @@ -54,12 +54,12 @@ public: * @result an OutputStream for the given base stream. */ _WRAP_CREATE(const Glib::RefPtr<OutputStream>& base_stream) - - /** Creates a new buffered output stream with a given buffer size. + + /** Creates a new buffered output stream with a given buffer size. * * @param base_stream An InputStream. * @param size A size. - * @result an OutputStream with an internal buffer set to size. + * @result an OutputStream with an internal buffer set to size. */ static Glib::RefPtr<BufferedOutputStream> create_sized(const Glib::RefPtr<OutputStream>& base_stream, gsize buffer_size); diff --git a/gio/src/converter.hg b/gio/src/converter.hg index fbd92be0..03195355 100644 --- a/gio/src/converter.hg +++ b/gio/src/converter.hg @@ -38,7 +38,7 @@ _WRAP_ENUM(ConverterFlags, GConverterFlags) * ways. The conversion can be stateful and may fail at any place. * * Some example conversions are: character set conversion, compression, - * decompression and regular expression replace. + * decompression and regular expression replace. * * @newin{2,34} */ diff --git a/gio/src/converterinputstream.hg b/gio/src/converterinputstream.hg index c7b9f994..8c0e39af 100644 --- a/gio/src/converterinputstream.hg +++ b/gio/src/converterinputstream.hg @@ -36,7 +36,7 @@ class InputStream; class ConverterInputStream : public FilterInputStream, public PollableInputStream { - _CLASS_GOBJECT(ConverterInputStream, GConverterInputStream, G_CONVERTER_INPUT_STREAM, FilterInputStream, GFilterInputStream) + _CLASS_GOBJECT(ConverterInputStream, GConverterInputStream, G_CONVERTER_INPUT_STREAM, FilterInputStream, GFilterInputStream) _IMPLEMENTS_INTERFACE(PollableInputStream) protected: diff --git a/gio/src/converteroutputstream.hg b/gio/src/converteroutputstream.hg index 6fea0271..eeb5d9d8 100644 --- a/gio/src/converteroutputstream.hg +++ b/gio/src/converteroutputstream.hg @@ -36,7 +36,7 @@ class OutputStream; class ConverterOutputStream : public FilterOutputStream, public PollableOutputStream { - _CLASS_GOBJECT(ConverterOutputStream, GConverterOutputStream, G_CONVERTER_OUTPUT_STREAM, FilterOutputStream, GFilterOutputStream) + _CLASS_GOBJECT(ConverterOutputStream, GConverterOutputStream, G_CONVERTER_OUTPUT_STREAM, FilterOutputStream, GFilterOutputStream) _IMPLEMENTS_INTERFACE(PollableOutputStream) protected: diff --git a/gio/src/dbusconnection.hg b/gio/src/dbusconnection.hg index d8be6e1b..5537e005 100644 --- a/gio/src/dbusconnection.hg +++ b/gio/src/dbusconnection.hg @@ -56,7 +56,7 @@ _GMMPROC_EXTRA_NAMESPACE(DBus) /** @defgroup DBus D-Bus API * * API to use D-Bus services as a client or to implement a D-Bus service. - * To write client code, see Gio::DBus::Proxy. + * To write client code, see Gio::DBus::Proxy. * To export objects on the bus for other clients, see Gio::DBus::own_name(), for instance. */ @@ -943,10 +943,10 @@ public: const Glib::RefPtr<InterfaceInfo>& interface_info, const InterfaceVTable& vtable); _IGNORE(g_dbus_connection_register_object) - + /** Registers exported objects at @a object_path with the D-Bus - * interface that is described in @a interface_info. This method overload, - * which does not take a VTable, is useful for + * interface that is described in @a interface_info. This method overload, + * which does not take a VTable, is useful for * <a href=="http://en.wikipedia.org/wiki/Marker_interface_pattern">marker * interfaces</href>. * diff --git a/gio/src/dbuserrorutils.hg b/gio/src/dbuserrorutils.hg index 00b576a0..a2c8ece7 100644 --- a/gio/src/dbuserrorutils.hg +++ b/gio/src/dbuserrorutils.hg @@ -38,9 +38,9 @@ namespace ErrorUtils /** Checks if @a error represents an error received via D-Bus from a remote * peer. If so, use get_remote_error() to get the name of the error. * - * @param error A Glib::Error. + * @param error A Glib::Error. * @return <tt>true</tt> if error represents an error from a remote peer, - * <tt>false</tt> otherwise. + * <tt>false</tt> otherwise. * @newin{2,28} * @ingroup DBus */ @@ -67,9 +67,9 @@ Glib::ustring get_remote_error(const Glib::Error& error); * * This is typically used when presenting errors to the end user. * - * @param error A Glib::Error. + * @param error A Glib::Error. * @return <tt>true</tt> if information was stripped, <tt>false</tt> - * otherwise. + * otherwise. * @newin{2,28} * @ingroup DBus */ diff --git a/gio/src/dbusintrospection.ccg b/gio/src/dbusintrospection.ccg index cd6c2971..771dbef7 100644 --- a/gio/src/dbusintrospection.ccg +++ b/gio/src/dbusintrospection.ccg @@ -26,18 +26,18 @@ namespace Gio namespace DBus { -//We hand-code this because g_dbus_node_info_lookup_interface() doesn't +//We hand-code this because g_dbus_node_info_lookup_interface() doesn't //do this when it takes a NULL. //See bug https://bugzilla.gnome.org/show_bug.cgi?id=646417 Glib::RefPtr<InterfaceInfo> NodeInfo::lookup_interface() { Glib::RefPtr<InterfaceInfo> retvalue; - + if(!gobj() || !(gobj()->interfaces)) return retvalue; retvalue = Glib::wrap(gobj()->interfaces[0]); - + if(retvalue) retvalue->reference(); //The function does not do a ref for us. @@ -48,7 +48,7 @@ Glib::RefPtr<const InterfaceInfo> NodeInfo::lookup_interface() const { return const_cast<NodeInfo*>(this)->lookup_interface(); } - + } //namespace DBus - + } // namespace Gio diff --git a/gio/src/dbusintrospection.hg b/gio/src/dbusintrospection.hg index 1e156374..9613edf0 100644 --- a/gio/src/dbusintrospection.hg +++ b/gio/src/dbusintrospection.hg @@ -140,7 +140,7 @@ public: _WRAP_METHOD(Glib::RefPtr<InterfaceInfo> lookup_interface(const Glib::ustring& name), g_dbus_node_info_lookup_interface, refreturn) _WRAP_METHOD(Glib::RefPtr<const InterfaceInfo> lookup_interface(const Glib::ustring& name) const, g_dbus_node_info_lookup_interface, constversion, refreturn) - + /** Looks up information about the first interface. */ Glib::RefPtr<InterfaceInfo> lookup_interface(); @@ -148,7 +148,7 @@ public: /** Looks up information about the first interface. */ Glib::RefPtr<const InterfaceInfo> lookup_interface() const; - + //TODO: _WRAP_METHOD(void generate_xml(guint indent, GString* string_builder), g_dbus_node_info_generate_xml) }; diff --git a/gio/src/dbusmessage.hg b/gio/src/dbusmessage.hg index 4e5c5b15..3ca25115 100644 --- a/gio/src/dbusmessage.hg +++ b/gio/src/dbusmessage.hg @@ -64,7 +64,7 @@ public: // See here about whether the parameters should be ustring or std::string: // http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names - // They are generally UTF-8 that can only contain the ASCII subset, + // They are generally UTF-8 that can only contain the ASCII subset, // so ustring still seems preferrable to std::string, which generally implies an unknown endoding for us. _WRAP_METHOD(static Glib::RefPtr<Message> create_signal(const Glib::ustring& path, const Glib::ustring& interface, const Glib::ustring& signal), g_dbus_message_new_signal) diff --git a/gio/src/drive.ccg b/gio/src/drive.ccg index a51d749b..c0568616 100644 --- a/gio/src/drive.ccg +++ b/gio/src/drive.ccg @@ -49,7 +49,7 @@ void Drive::eject(const SlotAsyncReady& slot, MountUnmountFlags flags) SlotAsyncReady* slot_copy = new SlotAsyncReady(slot); g_drive_eject_with_operation(gobj(), - static_cast<GMountUnmountFlags>(flags), + static_cast<GMountUnmountFlags>(flags), 0, // mount_operation 0, // cancellable &SignalProxy_async_callback, @@ -89,7 +89,7 @@ void Drive::eject(const Glib::RefPtr<MountOperation>& mount_operation, const Slo void Drive::eject(const Glib::RefPtr<MountOperation>& mount_operation, MountUnmountFlags flags) { g_drive_eject_with_operation(gobj(), - static_cast<GMountUnmountFlags>(flags), + static_cast<GMountUnmountFlags>(flags), Glib::unwrap(mount_operation), 0, // cancellable 0, // callback @@ -99,7 +99,7 @@ void Drive::eject(const Glib::RefPtr<MountOperation>& mount_operation, MountUnmo void Drive::eject(MountUnmountFlags flags) { g_drive_eject_with_operation(gobj(), - static_cast<GMountUnmountFlags>(flags), + static_cast<GMountUnmountFlags>(flags), 0, // mount_operation 0, // cancellable 0, // callback diff --git a/gio/src/drive.hg b/gio/src/drive.hg index 3d60f517..b3406666 100644 --- a/gio/src/drive.hg +++ b/gio/src/drive.hg @@ -40,11 +40,11 @@ _WRAP_ENUM(DriveStartStopType, GDriveStartStopType) /** Virtual File System drive management. * * This represent a piece of hardware connected to the machine. It's generally only created for removable hardware or hardware with removable media. - * Gio::Drive is a container class for Gio::Volume objects that stem from the same piece of media. As such, Gio::Drive abstracts a drive with - * (or without) removable media and provides operations for querying whether media is available, determing whether media change is automatically + * Gio::Drive is a container class for Gio::Volume objects that stem from the same piece of media. As such, Gio::Drive abstracts a drive with + * (or without) removable media and provides operations for querying whether media is available, determing whether media change is automatically * detected and ejecting the media. * - * If the Gio::Drive reports that media isn't automatically detected, one can poll for media; typically one should not do this periodically as a + * If the Gio::Drive reports that media isn't automatically detected, one can poll for media; typically one should not do this periodically as a * poll for media operation is potententially expensive and may spin up the drive, creating noise. * * @newin{2,16} @@ -127,7 +127,7 @@ public: errthrow) _WRAP_METHOD(std::string get_identifier(const std::string& kind) const, g_drive_get_identifier) - + #m4 _CONVERSION(`char**',`Glib::StringArrayHandle',`Glib::StringArrayHandle($3, Glib::OWNERSHIP_DEEP)') _WRAP_METHOD(Glib::StringArrayHandle enumerate_identifiers() const, g_drive_enumerate_identifiers) @@ -184,11 +184,11 @@ Glib::RefPtr<Gio::Drive> wrap(GDrive* object, bool take_copy); namespace Container_Helpers { -/** This specialization of TypeTraits exists - * because the default use of Glib::wrap(GObject*), +/** This specialization of TypeTraits exists + * because the default use of Glib::wrap(GObject*), * instead of a specific Glib::wrap(GSomeInterface*), * would not return a wrapper for an interface. - */ + */ template <> struct TypeTraits< Glib::RefPtr<Gio::Drive> > { @@ -201,7 +201,7 @@ struct TypeTraits< Glib::RefPtr<Gio::Drive> > static CppType to_cpp_type (const CType& item) { - //Use a specific Glib::wrap() function, + //Use a specific Glib::wrap() function, //because CType has the specific type (not just GObject): return Glib::wrap(item, true /* take_copy */); } diff --git a/gio/src/file.ccg b/gio/src/file.ccg index 04b1bf44..1216ff07 100644 --- a/gio/src/file.ccg +++ b/gio/src/file.ccg @@ -971,7 +971,7 @@ void File::unmount_mountable(MountUnmountFlags flags) { g_file_unmount_mountable_with_operation(gobj(), - static_cast<GMountUnmountFlags>(flags), + static_cast<GMountUnmountFlags>(flags), 0, 0, 0, @@ -1013,7 +1013,7 @@ void File::unmount_mountable(const Glib::RefPtr<MountOperation>& mount_operation, MountUnmountFlags flags) { g_file_unmount_mountable_with_operation(gobj(), - static_cast<GMountUnmountFlags>(flags), + static_cast<GMountUnmountFlags>(flags), Glib::unwrap(mount_operation), 0, 0, diff --git a/gio/src/file.hg b/gio/src/file.hg index 47cad106..b0b07ed7 100644 --- a/gio/src/file.hg +++ b/gio/src/file.hg @@ -58,29 +58,29 @@ _WRAP_ENUM(FileMonitorFlags, GFileMonitorFlags, NO_GTYPE) /** File and directory handling. - * Gio::File is a high level abstraction for manipulating files on a virtual file system. Gio::Files are lightweight, immutable objects that do no - * I/O upon creation. It is necessary to understand that a Gio::File object does not represent a file, merely a handle to a file. All file I/O is + * Gio::File is a high level abstraction for manipulating files on a virtual file system. Gio::Files are lightweight, immutable objects that do no + * I/O upon creation. It is necessary to understand that a Gio::File object does not represent a file, merely a handle to a file. All file I/O is * implemented as streaming operations (see Gio::InputStream and Gio::OutputStream). * * A GioFile can be constructed from a path, URI, or a command line argument. * - * You can move through the filesystem with Gio::File handles with get_parent() to get a handle to the parent directory, + * You can move through the filesystem with Gio::File handles with get_parent() to get a handle to the parent directory, * get_child() to get a handle to a child within a directory, and resolve_relative_path() to resolve a relative path between two Gio::Files. * - * Many Gio::File operations have both synchronous and asynchronous versions to suit your application. Asynchronous versions of synchronous - * functions simply have _async() appended to their function names. The asynchronous I/O functions call a SlotAsyncReady callback slot which is + * Many Gio::File operations have both synchronous and asynchronous versions to suit your application. Asynchronous versions of synchronous + * functions simply have _async() appended to their function names. The asynchronous I/O functions call a SlotAsyncReady callback slot which is * then used to finalize the operation, producing a AsyncResult which is then passed to the function's matching _finish() operation. * - * Some Gio::File operations do not have synchronous analogs, as they may take a very long time to finish, and blocking may leave an application - * unusable. Notable cases include: mount_mountable() to mount a mountable file, unmount_mountable() to unmount a mountable file, + * Some Gio::File operations do not have synchronous analogs, as they may take a very long time to finish, and blocking may leave an application + * unusable. Notable cases include: mount_mountable() to mount a mountable file, unmount_mountable() to unmount a mountable file, * and eject_mountable() to eject a mountable file. - * - * One notable feature of Gio::Files are entity tags, or "etags" for short. Entity tags are somewhat like a more abstract version of the - * traditional mtime, and can be used to quickly determine if the file has been modified from the version on the file system. + * + * One notable feature of Gio::Files are entity tags, or "etags" for short. Entity tags are somewhat like a more abstract version of the + * traditional mtime, and can be used to quickly determine if the file has been modified from the version on the file system. * See the HTTP 1.1 specification for HTTP Etag headers, which are a very similar concept. * * @newin{2,16} - */ + */ class File : public Glib::Interface { _CLASS_INTERFACE(File, GFile, G_FILE, GFileIface) @@ -116,8 +116,8 @@ public: static Glib::RefPtr<File> create_for_uri(const std::string& uri); _IGNORE(g_file_new_for_uri) - /** Constructs a File for a given argument from the command line. - * The value of @a arg can be either a URI, an absolute path or a relative path resolved relative to the current working directory. + /** Constructs a File for a given argument from the command line. + * The value of @a arg can be either a URI, an absolute path or a relative path resolved relative to the current working directory. * This operation never fails, but the returned object might not support any I/O operation if arg points to a malformed path. * * @param arg A string containing a relative or absolute path. @@ -148,7 +148,7 @@ public: _WRAP_METHOD(std::string get_uri() const, g_file_get_uri) _WRAP_METHOD(Glib::ustring get_parse_name() const, g_file_get_parse_name) - //Note that these return a reference (usually new instances, + //Note that these return a reference (usually new instances, //so we don't need to use refreturn. //TODO: Do we need const and unconst versions of these get_*() methods, @@ -218,16 +218,16 @@ public: /** Gets an output stream for appending data to the file. If * the file doesn't already exist it is created. - * + * * By default files created are generally readable by everyone, * but if you pass FILE_CREATE_PRIVATE in @a flags the file * will be made readable only to the current user, to the level that * is supported on the target filesystem. - * + * * The operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, a Gio::Error with CANCELLED will be thrown. - * + * was cancelled, a Gio::Error with CANCELLED will be thrown. + * * Some filesystems don't allow all filenames, and may * throw a Gio::Error with INVALID_FILENAME. * If the file is a directory a Gio::Error with IS_DIRECTORY will be @@ -241,15 +241,15 @@ public: /** Gets an output stream for appending data to the file. If * the file doesn't already exist it is created. - * + * * By default files created are generally readable by everyone, * but if you pass FILE_CREATE_PRIVATE in @a flags the file * will be made readable only to the current user, to the level that * is supported on the target filesystem. - * + * * Some filesystems don't allow all filenames, and may * throw a Gio::Error with INVALID_FILENAME. - * If the file is a directory a Gio::Error with IS_DIRECTORY will be + * If the file is a directory a Gio::Error with IS_DIRECTORY will be * thrown. Other errors are possible too, and depend on what kind of * filesystem the file is on. * @param flags A set of FileCreateFlags. @@ -258,21 +258,21 @@ public: Glib::RefPtr<FileOutputStream> append_to(FileCreateFlags flags = FILE_CREATE_NONE); _IGNORE(g_file_append_to) - //We renamed this to create_file from (g_file_create() and g_file_create_readwrite), to avoid confusion with static create() methods, + //We renamed this to create_file from (g_file_create() and g_file_create_readwrite), to avoid confusion with static create() methods, //but I would still like to choose a different word, but can't think of a good one. murrayc. /** Creates a new file and returns an output stream for writing to it. * The file must not already exist. - * + * * By default files created are generally readable by everyone, * but if you pass FILE_CREATE_PRIVATE in @a flags the file * will be made readable only to the current user, to the level that * is supported on the target filesystem. - * - * The operation can be cancelled by triggering the cancellable object from another thread. + * + * The operation can be cancelled by triggering the cancellable object from another thread. * If the operation was cancelled, a Gio::Error with CANCELLED will be thrown. - * - * If a file with this name already exists a Gio::Error with EXISTS + * + * If a file with this name already exists a Gio::Error with EXISTS * will be thrown. If the file is a directory a Gio::Error with IS_DIRECTORY * will be thrown. * @@ -290,13 +290,13 @@ public: /** Creates a new file and returns an output stream for writing to it. * The file must not already exist. - * + * * By default files created are generally readable by everyone, * but if you pass FILE_CREATE_PRIVATE in @a flags the file * will be made readable only to the current user, to the level that * is supported on the target filesystem. - * - * If a file with this name already exists a Gio::Error with EXISTS + * + * If a file with this name already exists a Gio::Error with EXISTS * will be thrown. If the file is a directory a Gio::Error with IS_DIRECTORY * will be thrown. * @@ -314,16 +314,16 @@ public: /** Creates a new file and returns a stream for reading and writing to it. * The file must not already exist. - * + * * By default files created are generally readable by everyone, * but if you pass FILE_CREATE_PRIVATE in @a flags the file * will be made readable only to the current user, to the level that * is supported on the target filesystem. - * - * The operation can be cancelled by triggering the cancellable object from another thread. + * + * The operation can be cancelled by triggering the cancellable object from another thread. * If the operation was cancelled, a Gio::Error with CANCELLED will be thrown. - * - * If a file with this name already exists a Gio::Error with EXISTS + * + * If a file with this name already exists a Gio::Error with EXISTS * will be thrown. If the file is a directory a Gio::Error with IS_DIRECTORY * will be thrown. * @@ -345,13 +345,13 @@ public: /** Creates a new file and returns a stream for reading and writing to it. * The file must not already exist. - * + * * By default files created are generally readable by everyone, * but if you pass FILE_CREATE_PRIVATE in @a flags the file * will be made readable only to the current user, to the level that * is supported on the target filesystem. - * - * If a file with this name already exists a Gio::Error with EXISTS + * + * If a file with this name already exists a Gio::Error with EXISTS * will be thrown. If the file is a directory a Gio::Error with IS_DIRECTORY * will be thrown. * @@ -374,33 +374,33 @@ public: /** Returns an output stream for overwriting the file, possibly creating a backup copy of the file first. - * This will try to replace the file in the safest way possible so that any errors during the writing will - * not affect an already existing copy of the file. For instance, for local files it may write to a + * This will try to replace the file in the safest way possible so that any errors during the writing will + * not affect an already existing copy of the file. For instance, for local files it may write to a * temporary file and then atomically rename over the destination when the stream is closed. * - * By default files created are generally readable by everyone, but if you pass FILE_CREATE_PRIVATE in - * @a flags the file will be made readable only to the current user, to the level that is supported on the + * By default files created are generally readable by everyone, but if you pass FILE_CREATE_PRIVATE in + * @a flags the file will be made readable only to the current user, to the level that is supported on the * target filesystem. * - * The operation can be cancelled by triggering the cancellable object from another thread. + * The operation can be cancelled by triggering the cancellable object from another thread. * If the operation was cancelled, a Gio::Error with CANCELLED will be thrown. * - * If you pass in an etag value, then this value is compared to the current entity tag of the file, - * and if they differ a Gio::Error with WRONG_ETAG will be thrown. This generally means that the file has - * been changed since you last read it. You can get the new etag from FileOutputStream::get_etag() - * after you've finished writing and closed the FileOutputStream. When you load a new file you can + * If you pass in an etag value, then this value is compared to the current entity tag of the file, + * and if they differ a Gio::Error with WRONG_ETAG will be thrown. This generally means that the file has + * been changed since you last read it. You can get the new etag from FileOutputStream::get_etag() + * after you've finished writing and closed the FileOutputStream. When you load a new file you can * use FileInputStream::query_info() to get the etag of the file. * - * If @a make_backup is true, this function will attempt to make a backup of the current file before - * overwriting it. If this fails aa Gio::Error with CANT_CREATE_BACKUP will be thrown. If you want to replace + * If @a make_backup is true, this function will attempt to make a backup of the current file before + * overwriting it. If this fails aa Gio::Error with CANT_CREATE_BACKUP will be thrown. If you want to replace * anyway, try again with @a make_backup set to false. * - * If the file is a directory a Gio::Error with IS_DIRECTORY will be thrown, and if the file is some - * other form of non-regular file then aa Gio::Error with NOT_REGULAR_FILE will be thrown. Some file - * systems don't allow all file names, and may throw a Gio::Error with INVALID_FILENAME, and if the - * name is to longa Gio::Error with FILENAME_TOO_LONG will be thrown. Other errors are possible too, and + * If the file is a directory a Gio::Error with IS_DIRECTORY will be thrown, and if the file is some + * other form of non-regular file then aa Gio::Error with NOT_REGULAR_FILE will be thrown. Some file + * systems don't allow all file names, and may throw a Gio::Error with INVALID_FILENAME, and if the + * name is to longa Gio::Error with FILENAME_TOO_LONG will be thrown. Other errors are possible too, and * depend on what kind of filesystem the file is on. - * + * * @param etag An optional entity tag for the current Glib::File. * @param make_backup <tt>true</tt> if a backup should be created. * @param flags A set of FileCreateFlags. @@ -410,30 +410,30 @@ public: /** Returns an output stream for overwriting the file, possibly creating a backup copy of the file first. - * This will try to replace the file in the safest way possible so that any errors during the writing will - * not affect an already existing copy of the file. For instance, for local files it may write to a + * This will try to replace the file in the safest way possible so that any errors during the writing will + * not affect an already existing copy of the file. For instance, for local files it may write to a * temporary file and then atomically rename over the destination when the stream is closed. * - * By default files created are generally readable by everyone, but if you pass FILE_CREATE_PRIVATE in - * @a flags the file will be made readable only to the current user, to the level that is supported on the + * By default files created are generally readable by everyone, but if you pass FILE_CREATE_PRIVATE in + * @a flags the file will be made readable only to the current user, to the level that is supported on the * target filesystem. * - * If you pass in an etag value, then this value is compared to the current entity tag of the file, - * and if they differ a Gio::Error with WRONG_ETAG will be thrown. This generally means that the file has - * been changed since you last read it. You can get the new etag from FileOutputStream::get_etag() - * after you've finished writing and closed the FileOutputStream. When you load a new file you can + * If you pass in an etag value, then this value is compared to the current entity tag of the file, + * and if they differ a Gio::Error with WRONG_ETAG will be thrown. This generally means that the file has + * been changed since you last read it. You can get the new etag from FileOutputStream::get_etag() + * after you've finished writing and closed the FileOutputStream. When you load a new file you can * use FileInputStream::query_info() to get the etag of the file. * - * If @a make_backup is true, this function will attempt to make a backup of the current file before - * overwriting it. If this fails aa Gio::Error with CANT_CREATE_BACKUP will be thrown. If you want to replace + * If @a make_backup is true, this function will attempt to make a backup of the current file before + * overwriting it. If this fails aa Gio::Error with CANT_CREATE_BACKUP will be thrown. If you want to replace * anyway, try again with @a make_backup set to false. * - * If the file is a directory a Gio::Error with IS_DIRECTORY will be thrown, and if the file is some - * other form of non-regular file then aa Gio::Error with NOT_REGULAR_FILE will be thrown. Some file - * systems don't allow all file names, and may throw a Gio::Error with INVALID_FILENAME, and if the - * name is to longa Gio::Error with FILENAME_TOO_LONG will be thrown. Other errors are possible too, and + * If the file is a directory a Gio::Error with IS_DIRECTORY will be thrown, and if the file is some + * other form of non-regular file then aa Gio::Error with NOT_REGULAR_FILE will be thrown. Some file + * systems don't allow all file names, and may throw a Gio::Error with INVALID_FILENAME, and if the + * name is to longa Gio::Error with FILENAME_TOO_LONG will be thrown. Other errors are possible too, and * depend on what kind of filesystem the file is on. - * + * * @param etag An optional entity tag for the current Glib::File. * @param make_backup <tt>true</tt> if a backup should be created. * @param flags A set of FileCreateFlags. @@ -446,7 +446,7 @@ public: /** Asynchronously opens the file for appending. * For more details, see append_to() which is the synchronous version of this call. - * + * * When the operation is finished, @a slot will be called. You can then call append_to_finish() to get the result of the operation. * @param slot A callback slot which will be called when the request is satisfied. * @param cancellable A Cancellable object which can be used to cancel the operation. @@ -457,7 +457,7 @@ public: /** Asynchronously opens the file for appending. * For more details, see append_to() which is the synchronous version of this call. - * + * * When the operation is finished, @a slot will be called. You can then call append_to_finish() to get the result of the operation. * @param slot A callback slot which will be called when the request is satisfied. * @param flags a set of FileCreateFlags. @@ -471,14 +471,14 @@ public: refreturn, errthrow) - //We renamed this to create_file_async from (g_file_create_async() and g_file_create_readwrite_async), to avoid confusion with static create() methods, + //We renamed this to create_file_async from (g_file_create_async() and g_file_create_readwrite_async), to avoid confusion with static create() methods, //but I would still like to choose a different word, but can't think of a good one. murrayc. See also create_file(). /** Asynchronously creates a new file and returns an output stream for writing to it. The file must not already exist. * For more details, see create_file() which is the synchronous version of this call. * * When the operation is finished, @a slot will be called. You can then call create_file_finish() to get the result of the operation. - * + * * @param slot A callback slot which will be called when the request is satisfied. * @param cancellable A Cancellable object which can be used to cancel the operation. * @param flags a set of FileCreateFlags. @@ -490,7 +490,7 @@ public: * For more details, see create_file() which is the synchronous version of this call. * * When the operation is finished, @a slot will be called. You can then call create_file_finish() to get the result of the operation. - * + * * @param slot A callback slot which will be called when the request is satisfied. * @param flags a set of FileCreateFlags. * @param io_priority The I/O priority of the request. @@ -509,7 +509,7 @@ public: * For more details, see create_file_readwrite() which is the synchronous version of this call. * * When the operation is finished, @a slot will be called. You can then call create_file_readwrite_finish() to get the result of the operation. - * + * * @param slot A callback slot which will be called when the request is satisfied. * @param cancellable A Cancellable object which can be used to cancel the operation. * @param flags a set of FileCreateFlags. @@ -525,7 +525,7 @@ public: * For more details, see create_file_readwrite() which is the synchronous version of this call. * * When the operation is finished, @a slot will be called. You can then call create_file_readwrite_finish() to get the result of the operation. - * + * * @param slot A callback slot which will be called when the request is satisfied. * @param flags a set of FileCreateFlags. * @param io_priority The I/O priority of the request. @@ -623,15 +623,15 @@ public: /** Returns an output stream for overwriting the file in readwrite mode, possibly creating a backup copy of the file first. - * + * * If the file doesn't exist, it will be created. * * For details about the behaviour, see replace() which does the same thing but returns an output stream only. * - * Note that in many non-local file cases read and write streams are not supported, + * Note that in many non-local file cases read and write streams are not supported, * so make sure you really need to do read and write streaming, * rather than just opening for reading or writing. - * + * * @param etag An optional entity tag for the current Glib::File. * @param make_backup <tt>true</tt> if a backup should be created. * @param flags A set of FileCreateFlags. @@ -643,15 +643,15 @@ public: /** Returns an output stream for overwriting the file in readwrite mode, possibly creating a backup copy of the file first. - * + * * If the file doesn't exist, it will be created. * * For details about the behaviour, see replace() which does the same thing but returns an output stream only. * - * Note that in many non-local file cases read and write streams are not supported, + * Note that in many non-local file cases read and write streams are not supported, * so make sure you really need to do read and write streaming, * rather than just opening for reading or writing. - * + * * @param etag An optional entity tag for the current Glib::File. * @param make_backup <tt>true</tt> if a backup should be created. * @param flags A set of FileCreateFlags. @@ -717,10 +717,10 @@ public: * means all attributes, and a wildcard like "standard::*" means all attributes in the standard * namespace. An example attribute query be "standard::*,owner::user". * The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME. - * + * * The operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, a Gio::Error with CANCELLED will be thrown. + * was cancelled, a Gio::Error with CANCELLED will be thrown. * * For symlinks, normally the information about the target of the * symlink is returned, rather than information about the symlink itself. @@ -822,7 +822,7 @@ public: * about the filesystem the file is on, rather than the file itself. * For instance the amount of space availible and the type of * the filesystem. - * + * * The @a attribute value is a string that specifies the file attributes that * should be gathered. It is not an error if its not possible to read a particular * requested attribute from a file, it just won't be set. @a attribute should @@ -832,11 +832,11 @@ public: * Common attributes of interest are FILE_ATTRIBUTE_FILESYSTEM_SIZE * (the total size of the filesystem in bytes), FILE_ATTRIBUTE_FILESYSTEM_FREE (number of * bytes availible), and FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem). - * + * * The operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, a Gio::Error with CANCELLED will be thrown. - * + * was cancelled, a Gio::Error with CANCELLED will be thrown. + * * If the file does not exist, a Gio::Error with NOT_FOUND will be thrown. * Other errors are possible too, and depend on what kind of filesystem the file is on. * @param cancellable A Cancellable object. @@ -849,7 +849,7 @@ public: * about the filesystem the file is on, rather than the file itself. * For instance the amount of space availible and the type of * the filesystem. - * + * * The @a attribute value is a string that specifies the file attributes that * should be gathered. It is not an error if its not possible to read a particular * requested attribute from a file, it just won't be set. @a attribute should @@ -859,8 +859,8 @@ public: * Common attributes of interest are FILE_ATTRIBUTE_FILESYSTEM_SIZE * (the total size of the filesystem in bytes), FILE_ATTRIBUTE_FILESYSTEM_FREE (number of * bytes availible), and FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem). - * - * + * + * * If the file does not exist, a Gio::Error with NOT_FOUND will be thrown. * Other errors are possible too, and depend on what kind of filesystem the file is on. * @param attributes An attribute query string. @@ -869,7 +869,7 @@ public: Glib::RefPtr<FileInfo> query_filesystem_info(const std::string& attributes = "*"); _IGNORE(g_file_query_filesystem_info) - _WRAP_METHOD(Glib::RefPtr<Mount> find_enclosing_mount(const Glib::RefPtr<Cancellable>& cancellable{?}), + _WRAP_METHOD(Glib::RefPtr<Mount> find_enclosing_mount(const Glib::RefPtr<Cancellable>& cancellable{?}), g_file_find_enclosing_mount, retreturn, errthrow) @@ -877,7 +877,7 @@ public: * that the file is on. The result is a FileInfo object * that contains key-value attributes (such as type or size for the * file). - * + * * For more details, see query_filesystem_info() which is the synchronous version of this call. * * When the operation is finished, @a slot will be called. You can then call query_filesystem_info_finish() to get the result of the operation. @@ -893,7 +893,7 @@ public: * that the file is on. The result is a FileInfo object * that contains key-value attributes (such as type or size for the * file). - * + * * For more details, see query_filesystem_info() which is the synchronous version of this call. * * When the operation is finished, @a slot will be called. You can then call query_filesystem_info_finish() to get the result of the operation. @@ -938,14 +938,14 @@ public: void find_enclosing_mount_async(const SlotAsyncReady& slot, int io_priority = Glib::PRIORITY_DEFAULT); _IGNORE(g_file_find_enclosing_mount_async) - _WRAP_METHOD(Glib::RefPtr<Mount> find_enclosing_mount_finish(const Glib::RefPtr<AsyncResult>& result), + _WRAP_METHOD(Glib::RefPtr<Mount> find_enclosing_mount_finish(const Glib::RefPtr<AsyncResult>& result), g_file_find_enclosing_mount_finish, refreturn, errthrow) /** Gets the requested information about the files in a directory. The result * is a FileEnumerator object that will give out FileInfo objects for * all the files in the directory. - * + * * The @a attribute value is a string that specifies the file attributes that * should be gathered. It is not an error if its not possible to read a particular * requested attribute from a file, it just won't be set. @a attribute should @@ -953,11 +953,11 @@ public: * means all attributes, and a wildcard like "standard::*" means all attributes in the standard * namespace. An example attribute query be "standard::*,owner::user". * The standard attributes are availible as defines, like FILE_ATTRIBUTE_STANDARD_NAME. - * + * * The operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, a Gio::Error with CANCELLED will be thrown. - * + * was cancelled, a Gio::Error with CANCELLED will be thrown. + * * If the file does not exist, a Gio::Error with NOT_FOUND will be thrown. * If the file is not a directory, a Glib::FileError with NOTDIR will be thrown. * Other errors are possible too. @@ -973,7 +973,7 @@ public: /** Gets the requested information about the files in a directory. The result * is a FileEnumerator object that will give out FileInfo objects for * all the files in the directory. - * + * * The @a attribute value is a string that specifies the file attributes that * should be gathered. It is not an error if its not possible to read a particular * requested attribute from a file, it just won't be set. @a attribute should @@ -981,7 +981,7 @@ public: * means all attributes, and a wildcard like "standard::*" means all attributes in the standard * namespace. An example attribute query be "standard::*,owner::user". * The standard attributes are availible as defines, like FILE_ATTRIBUTE_STANDARD_NAME. - * + * * If the file does not exist, a Gio::Error with NOT_FOUND will be thrown. * If the file is not a directory, a Glib::FileError with NOTDIR will be thrown. * Other errors are possible too. @@ -1053,9 +1053,9 @@ public: g_file_set_display_name_finish, errthrow) - /** Deletes a file. + /** Deletes a file. * If the file is a directory, it will only be deleted if it is empty. - * The operation can be cancelled by triggering the cancellable object from another thread. + * The operation can be cancelled by triggering the cancellable object from another thread. * If the operation was cancelled, a Glib::FileError with ERROR_CANCELLED will be thrown. * * @param cancellable A Cancellable object which can be used to cancel the operation. @@ -1116,10 +1116,10 @@ public: * * If FILE_COPY_OVERWRITE is not specified and the target exists, then a Gio::Error with EXISTS will be thrown. * - * If trying to overwrite a file over a directory a Gio::Error with IS_DIRECTORY will be thrown. + * If trying to overwrite a file over a directory a Gio::Error with IS_DIRECTORY will be thrown. * If trying to overwrite a directory with a directory a Gio::Error with WOULD_MERGE will be thrown. * - * If the source is a directory and the target does not exist, or FILE_COPY_OVERWRITE is specified and the target is a file, + * If the source is a directory and the target does not exist, or FILE_COPY_OVERWRITE is specified and the target is a file, * then a Gio::Error with WOULD_RECURSE will be thrown. * * If you are interested in copying the Gio::File object itself (not the on-disk file), see File::dup(). @@ -1136,10 +1136,10 @@ public: * * If FILE_COPY_OVERWRITE is not specified and the target exists, then a Gio::Error with EXISTS will be thrown. * - * If trying to overwrite a file over a directory a Gio::Error with IS_DIRECTORY will be thrown. + * If trying to overwrite a file over a directory a Gio::Error with IS_DIRECTORY will be thrown. * If trying to overwrite a directory with a directory a Gio::Error with WOULD_MERGE will be thrown. * - * If the source is a directory and the target does not exist, or FILE_COPY_OVERWRITE is specified and the target is a file, + * If the source is a directory and the target does not exist, or FILE_COPY_OVERWRITE is specified and the target is a file, * then a Gio::Error with WOULD_RECURSE will be thrown. * * If you are interested in copying the Gio::File object itself (not the on-disk file), see File::dup(). @@ -1154,10 +1154,10 @@ public: * * If FILE_COPY_OVERWRITE is not specified and the target exists, then a Gio::Error with EXISTS will be thrown. * - * If trying to overwrite a file over a directory a Gio::Error with IS_DIRECTORY will be thrown. + * If trying to overwrite a file over a directory a Gio::Error with IS_DIRECTORY will be thrown. * If trying to overwrite a directory with a directory a Gio::Error with WOULD_MERGE will be thrown. * - * If the source is a directory and the target does not exist, or FILE_COPY_OVERWRITE is specified and the target is a file, + * If the source is a directory and the target does not exist, or FILE_COPY_OVERWRITE is specified and the target is a file, * then a Gio::Error with WOULD_RECURSE will be thrown. * * If you are interested in copying the Gio::File object itself (not the on-disk file), see File::dup(). @@ -1234,24 +1234,24 @@ public: g_file_copy_finish, errthrow) - /** Tries to move the file or directory source to the location specified by destination. If native move operations are supported then this is - * used, otherwise a copy and delete fallback is used. The native implementation may support moving directories (for instance on moves inside + /** Tries to move the file or directory source to the location specified by destination. If native move operations are supported then this is + * used, otherwise a copy and delete fallback is used. The native implementation may support moving directories (for instance on moves inside * the same filesystem), but the fallback code does not. * * If the flag FILE_COPY_OVERWRITE is specified an already existing destination file is overwritten. - * + * * If the flag FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks will be copied as symlinks, otherwise the target of the source symlink will be copied. - * + * * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, a Gio::Error with CANCELLED will be thrown. * * The operation can be monitored via the @a slot callback. * If the source file does not exist then a Gio::Error with NOT_FOUND will be thrown, independent on the status of the destination. - * + * * If G_FILE_COPY_OVERWRITE is not specified and the target exists, then a Gio::Error with EXISTS will be thrown. - * - * If trying to overwrite a file over a directory a Gio::Error with IS_DIRECTORY will be thrown. + * + * If trying to overwrite a file over a directory a Gio::Error with IS_DIRECTORY will be thrown. * If trying to overwrite a directory with a directory a Gio::Error with WOULD_MERGE will be thrown. - * + * * If the source is a directory and the target does not exist, or FILE_COPY_OVERWRITE is specified and the target is a file, then a Gio::Error with WOULD_RECURSE may be thrown (if the native move operation isn't available). */ bool move(const Glib::RefPtr<File>& destination, const SlotFileProgress& slot, const Glib::RefPtr<Cancellable>& cancellable, FileCopyFlags flags = FILE_COPY_NONE); @@ -1292,16 +1292,16 @@ public: GError **error); */ - /** Tries to set all attributes in the FileInfo on the target values, + /** Tries to set all attributes in the FileInfo on the target values, * not stopping on the first error. - * + * * If there is any error during this operation then a Gio::Error will be thrown. - * Error on particular fields are flagged by setting - * the "status" field in the attribute value to + * Error on particular fields are flagged by setting + * the "status" field in the attribute value to * FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can also detect * further errors. - * - * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, + * + * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, * a Gio::Error with CANCELLED will be thrown. * * @param info A FileInfo. @@ -1311,16 +1311,16 @@ public: */ bool set_attributes_from_info(const Glib::RefPtr<FileInfo>& info, const Glib::RefPtr<Cancellable>& cancellable, FileQueryInfoFlags flags = FILE_QUERY_INFO_NONE); - /** Tries to set all attributes in the FileInfo on the target values, + /** Tries to set all attributes in the FileInfo on the target values, * not stopping on the first error. - * + * * If there is any error during this operation then a Gio::Error will be thrown. - * Error on particular fields are flagged by setting - * the "status" field in the attribute value to + * Error on particular fields are flagged by setting + * the "status" field in the attribute value to * FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can also detect * further errors. - * - * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, + * + * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, * a Gio::Error with CANCELLED will be thrown. * * @param info A FileInfo. @@ -1384,12 +1384,12 @@ public: g_file_set_attribute_int64, errthrow) - /** Starts a @a mount_operation, mounting the volume that contains the file. - * - * When this operation has completed, @a slot will be called with, + /** Starts a @a mount_operation, mounting the volume that contains the file. + * + * When this operation has completed, @a slot will be called with, * and the operation can be finalized with mount_enclosing_volume_finish(). - * - * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, + * + * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, * a Gio::Error with CANCELLED will be thrown. * * @param mount_operation A MountOperation. @@ -1398,9 +1398,9 @@ public: */ void mount_enclosing_volume(const Glib::RefPtr<MountOperation>& mount_operation, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, MountMountFlags flags = MOUNT_MOUNT_NONE); - /** Starts a @a mount_operation, mounting the volume that contains the file. - * - * When this operation has completed, @a slot will be called with, + /** Starts a @a mount_operation, mounting the volume that contains the file. + * + * When this operation has completed, @a slot will be called with, * and the operation can be finalized with mount_enclosing_volume_finish(). * * @param mount_operation A MountOperation. @@ -1408,9 +1408,9 @@ public: */ void mount_enclosing_volume(const Glib::RefPtr<MountOperation>& mount_operation, const SlotAsyncReady& slot, MountMountFlags flags = MOUNT_MOUNT_NONE); - /** Starts a @a mount_operation, mounting the volume that contains the file. - * - * When this operation has completed, @a slot will be called with, + /** Starts a @a mount_operation, mounting the volume that contains the file. + * + * When this operation has completed, @a slot will be called with, * and the operation can be finalized with mount_enclosing_volume_finish(). * * @param slot A callback slot which will be called when the request is satisfied. @@ -1418,7 +1418,7 @@ public: void mount_enclosing_volume(const SlotAsyncReady& slot, MountMountFlags flags = MOUNT_MOUNT_NONE); _IGNORE(g_file_mount_enclosing_volume) - /** Starts a @a mount_operation, mounting the volume that contains the file. + /** Starts a @a mount_operation, mounting the volume that contains the file. * */ void mount_enclosing_volume(MountMountFlags flags = MOUNT_MOUNT_NONE); @@ -1428,10 +1428,10 @@ public: g_file_mount_enclosing_volume_finish, errthrow) - /** Mounts a file of type FILE_TYPE_MOUNTABLE. Using @a mount_operation, you can request callbacks when, for instance, + /** Mounts a file of type FILE_TYPE_MOUNTABLE. Using @a mount_operation, you can request callbacks when, for instance, * passwords are needed during authentication. * - * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, + * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, * a Gio::Error with CANCELLED will be thrown. * * When the operation is finished, @a slot will be called. You can then call mount_mountable_finish() to get the result of the operation. @@ -1442,7 +1442,7 @@ public: */ void mount_mountable(const Glib::RefPtr<MountOperation>& mount_operation, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, MountMountFlags flags = MOUNT_MOUNT_NONE); - /** Mounts a file of type FILE_TYPE_MOUNTABLE. Using @a mount_operation, you can request callbacks when, for instance, + /** Mounts a file of type FILE_TYPE_MOUNTABLE. Using @a mount_operation, you can request callbacks when, for instance, * passwords are needed during authentication. * * When the operation is finished, @a slot will be called. You can then call mount_mountable_finish() to get the result of the operation. @@ -1471,7 +1471,7 @@ public: /** Unmounts a file of type FILE_TYPE_MOUNTABLE. * - * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, + * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, * a Gio::Error with CANCELLED will be thrown. * * When the operation is finished, @a slot will be called. You can then call unmount_mountable_finish() to get the result of the operation. @@ -1499,7 +1499,7 @@ public: /** Unmounts a file of type FILE_TYPE_MOUNTABLE. * - * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, + * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, * a Gio::Error with CANCELLED will be thrown. * * When the operation is finished, @a slot will be called. You can then call unmount_mountable_finish() to get the result of the operation. @@ -1542,7 +1542,7 @@ public: /** Starts an asynchronous eject on a mountable. * - * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, + * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, * a Gio::Error with CANCELLED will be thrown. * * When the operation is finished, @a slot will be called. You can then call eject_mountable_finish() to get the result of the operation. @@ -1570,7 +1570,7 @@ public: /** Starts an asynchronous eject on a mountable. * - * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, + * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, * a Gio::Error with CANCELLED will be thrown. * * When the operation is finished, @a slot will be called. You can then call eject_mountable_finish() to get the result of the operation. @@ -1612,7 +1612,7 @@ public: errthrow) - /** Copies the file attributes from @a source to @a destination. + /** Copies the file attributes from @a source to @a destination. * * Normally only a subset of the file attributes are copied, * those that are copies in a normal file copy operation @@ -1627,7 +1627,7 @@ public: */ bool copy_attributes(const Glib::RefPtr<File>& destination, const Glib::RefPtr<Cancellable>& cancellable, FileCopyFlags flags = FILE_COPY_NONE); - /** Copies the file attributes from @a source to @a destination. + /** Copies the file attributes from @a source to @a destination. * * Normally only a subset of the file attributes are copied, * those that are copies in a normal file copy operation @@ -1641,10 +1641,10 @@ public: */ bool copy_attributes(const Glib::RefPtr<File>& destination, FileCopyFlags flags = FILE_COPY_NONE); _IGNORE(g_file_copy_attributes) - + /** Obtains a directory monitor for the given file. * This may fail if directory monitoring is not supported. - * + * * The operation can be cancelled by triggering the cancellable object from another thread. If the operation * was cancelled, a Gio::Error with CANCELLED will be thrown. * @@ -1656,7 +1656,7 @@ public: /** Obtains a directory monitor for the given file. * This may fail if directory monitoring is not supported. - * + * * @param flags A set of FileMonitorFlags. * @return A FileMonitor for the file. */ @@ -1665,7 +1665,7 @@ public: /** Obtains a file monitor for the given file. If no file notification * mechanism exists, then regular polling of the file is used. - * + * * The operation can be cancelled by triggering the cancellable object from another thread. If the operation * was cancelled, a Gio::Error with CANCELLED will be thrown. * @@ -1677,7 +1677,7 @@ public: /** Obtains a file monitor for the given file. If no file notification * mechanism exists, then regular polling of the file is used. - * + * * The operation can be cancelled by triggering the cancellable object from another thread. If the operation * was cancelled, a Gio::Error with CANCELLED will be thrown. * @@ -1691,7 +1691,7 @@ public: /** Obtains a file monitor for the given file. If no file notification * mechanism exists, then regular polling of the file is used. - * + * * The operation can be cancelled by triggering the cancellable object from another thread. If the operation * was cancelled, a Gio::Error with CANCELLED will be thrown. * @@ -1705,7 +1705,7 @@ public: /** Obtains a file monitor for the given file. If no file notification * mechanism exists, then regular polling of the file is used. - * + * * The operation can be cancelled by triggering the cancellable object from another thread. If the operation * was cancelled, a Gio::Error with CANCELLED will be thrown. * @@ -1724,12 +1724,12 @@ public: * Using @a start_operation, you can request callbacks when, for instance, * passwords are needed during authentication. * - * When this operation has completed, @a slot will be called + * When this operation has completed, @a slot will be called * and the operation can be finalized with start_mountable_finish(). - * + * * The operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, a Gio::Error with CANCELLED will be thrown. + * was cancelled, a Gio::Error with CANCELLED will be thrown. * * @param slot: A callback to call when the request is satisfied. * @param cancellable A Cancellable object. @@ -1743,12 +1743,12 @@ public: * Using @a start_operation, you can request callbacks when, for instance, * passwords are needed during authentication. * - * When this operation has completed, @a slot will be called + * When this operation has completed, @a slot will be called * and the operation can be finalized with start_mountable_finish(). - * + * * The operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, a Gio::Error with CANCELLED will be thrown. + * was cancelled, a Gio::Error with CANCELLED will be thrown. * * @param slot: A callback to call when the request is satisfied. * @param cancellable A Cancellable object. @@ -1767,12 +1767,12 @@ public: * Using @a start_operation, you can request callbacks when, for instance, * passwords are needed during authentication. * - * When this operation has completed, @a slot will be called + * When this operation has completed, @a slot will be called * and the operation can be finalized with stop_mountable_finish(). - * + * * The operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, a Gio::Error with CANCELLED will be thrown. + * was cancelled, a Gio::Error with CANCELLED will be thrown. * * @param slot: A callback to call when the request is satisfied. * @param cancellable A Cancellable object. @@ -1787,12 +1787,12 @@ public: * Using @a start_operation, you can request callbacks when, for instance, * passwords are needed during authentication. * - * When this operation has completed, @a slot will be called + * When this operation has completed, @a slot will be called * and the operation can be finalized with stop_mountable_finish(). - * + * * The operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, a Gio::Error with CANCELLED will be thrown. + * was cancelled, a Gio::Error with CANCELLED will be thrown. * * @param slot: A callback to call when the request is satisfied. * @param start_operation A Cancellable object. @@ -1811,12 +1811,12 @@ public: * Using @a start_operation, you can request callbacks when, for instance, * passwords are needed during authentication. * - * When this operation has completed, @a slot will be called + * When this operation has completed, @a slot will be called * and the operation can be finalized with stop_mountable_finish(). - * + * * The operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, a Gio::Error with CANCELLED will be thrown. + * was cancelled, a Gio::Error with CANCELLED will be thrown. * * @param slot: A callback to call when the request is satisfied. * @param cancellable A Cancellable object. @@ -1830,12 +1830,12 @@ public: * Using @a start_operation, you can request callbacks when, for instance, * passwords are needed during authentication. * - * When this operation has completed, @a slot will be called + * When this operation has completed, @a slot will be called * and the operation can be finalized with stop_mountable_finish(). - * + * * The operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, a Gio::Error with CANCELLED will be thrown. + * was cancelled, a Gio::Error with CANCELLED will be thrown. * * @param slot: A callback to call when the request is satisfied. * @@ -1852,46 +1852,46 @@ public: errthrow) //TODO: Something better than char*& for contents? - /** Loads the content of the file into memory, returning the size of the data. + /** Loads the content of the file into memory, returning the size of the data. * The data is always zero terminated, but this is not included in the resultant @a length. - * - * The operation can be cancelled by triggering the cancellable object from another thread. + * + * The operation can be cancelled by triggering the cancellable object from another thread. * If the operation was cancelled, a Gio::Error exception with CANCELLED will be returned. * * @param cancellable A cancellable object. - * @param contents A location to place the contents of the file. + * @param contents A location to place the contents of the file. * @param length A location to place the length of the contents of the file. * @param etag_out A location to place the current entity tag for the file. */ bool load_contents(const Glib::RefPtr<Cancellable>& cancellable, char*& contents, gsize& length, std::string& etag_out); - /** Loads the content of the file into memory, returning the size of the data. + /** Loads the content of the file into memory, returning the size of the data. * The data is always zero terminated, but this is not included in the resultant @a length. - * - * The operation can be cancelled by triggering the cancellable object from another thread. + * + * The operation can be cancelled by triggering the cancellable object from another thread. * If the operation was cancelled, a Gio::Error exception with CANCELLED will be returned. * * @param cancellable A cancellable object. - * @param contents A location to place the contents of the file. + * @param contents A location to place the contents of the file. * @param length A location to place the length of the contents of the file. * @newin{2,22} */ bool load_contents(const Glib::RefPtr<Cancellable>& cancellable, char*& contents, gsize& length); //TODO: Something better than char*& for contents? - /** Loads the content of the file into memory, returning the size of the data. + /** Loads the content of the file into memory, returning the size of the data. * The data is always zero terminated, but this is not included in the resultant @a length. * - * @param contents A location to place the contents of the file. + * @param contents A location to place the contents of the file. * @param length A location to place the length of the contents of the file. * @param etag_out A location to place the current entity tag for the file. */ bool load_contents(char*& contents, gsize& length, std::string& etag_out); - /** Loads the content of the file into memory, returning the size of the data. + /** Loads the content of the file into memory, returning the size of the data. * The data is always zero terminated, but this is not included in the resultant @a length. * - * @param contents A location to place the contents of the file. + * @param contents A location to place the contents of the file. * @param length A location to place the length of the contents of the file. * @newin{2,22} */ @@ -1901,10 +1901,10 @@ public: /** Starts an asynchronous load of the file's contents. * For more details, see load_contents() which is the synchronous version of this call. * - * When the load operation has completed, the @a slot will be called. To finish the operation, + * When the load operation has completed, the @a slot will be called. To finish the operation, * call load_contents_finish() with the AsyncResult provided to the @a slot. * - * The operation can be cancelled by triggering the cancellable object from another thread. + * The operation can be cancelled by triggering the cancellable object from another thread. * If the operation was cancelled, a Gio::Error with CANCELLED will be thrown. * * @param slot A callback slot which will be called when the request is satisfied. @@ -1915,7 +1915,7 @@ public: /** Starts an asynchronous load of the file's contents. * For more details, see load_contents() which is the synchronous version of this call. * - * When the load operation has completed, the @a slot will be called. To finish the operation, + * When the load operation has completed, the @a slot will be called. To finish the operation, * call load_contents_finish() with the AsyncResult provided to the @a slot. * * @param slot A callback slot which will be called when the request is satisfied. @@ -1923,27 +1923,27 @@ public: void load_contents_async(const SlotAsyncReady& slot); _IGNORE(g_file_load_contents_async) - /** Finishes an asynchronous load of the @a file's contents. - * The contents are placed in @a contents, and @a length is set to the - * size of the @a contents string. If @a etag_out is present, it will be + /** Finishes an asynchronous load of the @a file's contents. + * The contents are placed in @a contents, and @a length is set to the + * size of the @a contents string. If @a etag_out is present, it will be * set to the new entity tag for the @a file. * @param res A AsyncResult. * @param contents A location to place the contents of the file. * @param length A location to place the length of the contents of the file. * @param etag_out A location to place the current entity tag for the file. - * @return <tt>true</tt> if the load was successful. If <tt>false</tt> and @a error is + * @return <tt>true</tt> if the load was successful. If <tt>false</tt> and @a error is * present, it will be set appropriately. */ bool load_contents_finish(const Glib::RefPtr<AsyncResult>& result, char*& contents, gsize& length, std::string& etag_out); - /** Finishes an asynchronous load of the @a file's contents. - * The contents are placed in @a contents, and @a length is set to the - * size of the @a contents string. If @a etag_out is present, it will be + /** Finishes an asynchronous load of the @a file's contents. + * The contents are placed in @a contents, and @a length is set to the + * size of the @a contents string. If @a etag_out is present, it will be * set to the new entity tag for the @a file. * @param res A AsyncResult. * @param contents A location to place the contents of the file. * @param length A location to place the length of the contents of the file. - * @return <tt>true</tt> if the load was successful. If <tt>false</tt> and @a error is + * @return <tt>true</tt> if the load was successful. If <tt>false</tt> and @a error is * present, it will be set appropriately. * @newin{2,22} */ @@ -1956,13 +1956,13 @@ public: */ typedef sigc::slot<bool, const char*, goffset> SlotReadMore; - //Note that slot_read_more can be NULL but that would not be a useful method overload, because the documentation says that it would + //Note that slot_read_more can be NULL but that would not be a useful method overload, because the documentation says that it would //then be equivalent to load_contents_async. /** Reads the partial contents of a file. * The @a slot_read_more callback slot should be used to stop reading from the file when appropriate. This operation can be finished by load_partial_contents_finish(). * - * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, + * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, * a Gio::Error with CANCELLED will be thrown. * * When the operation is finished, @a slot will be called. You can then call load_partial_contents_finish() to get the result of the operation. @@ -1976,7 +1976,7 @@ public: /** Reads the partial contents of a file. * The @a slot_read_more callback slot should be used to stop reading from the file when appropriate. This operation can be finished by load_partial_contents_finish(). * - * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, + * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, * a Gio::Error with CANCELLED will be thrown. * * When the operation is finished, @a slot will be called. You can then call load_partial_contents_finish() to get the result of the operation. @@ -1994,7 +1994,7 @@ public: * @param contents A location to place the contents of the file. * @param length A location to place the length of the contents of the file. * @param etag_out A location to place the current entity tag for the file. - * @return <tt>true</tt> if the load was successful. If <tt>false</tt> and @a error is + * @return <tt>true</tt> if the load was successful. If <tt>false</tt> and @a error is * present, it will be set appropriately. */ bool load_partial_contents_finish(const Glib::RefPtr<AsyncResult>& result, char*& contents, gsize& length, std::string& etag_out); @@ -2004,7 +2004,7 @@ public: * @param res A AsyncResult. * @param contents A location to place the contents of the file. * @param length A location to place the length of the contents of the file. - * @return <tt>true</tt> if the load was successful. If <tt>false</tt> and @a error is + * @return <tt>true</tt> if the load was successful. If <tt>false</tt> and @a error is * present, it will be set appropriately. * @newin{2,22} */ @@ -2012,21 +2012,21 @@ public: _IGNORE(g_file_load_partial_contents_finish) /** Replaces the contents of the file with @a contents of @a length bytes. - * + * * If @a etag is specified (not an empty string) any existing file must have that etag, or * a Gio::Error with WRONG_ETAG will be thrown. - * + * * If @a make_backup is <tt>true</tt>, this function will attempt to make a backup of the file. - * + * * The operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, a Gio::Error with CANCELLED will be thrown. - * + * was cancelled, a Gio::Error with CANCELLED will be thrown. + * * The returned @a new_etag can be used to verify that the file hasn't changed the * next time it is saved over. * @param contents A string containing the new contents for the file. * @param length The length of @a contents in bytes. - * @param etag The old entity tag + * @param etag The old entity tag * for the document. * @param make_backup <tt>true</tt> if a backup should be created. * @param flags A set of FileCreateFlags. @@ -2037,17 +2037,17 @@ public: void replace_contents(const char* contents, gsize length, const std::string& etag, std::string& new_etag, const Glib::RefPtr<Cancellable>& cancellable, bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE); /** Replaces the contents of the file with @a contents of @a length bytes. - * + * * If @a etag is specified (not an empty string) any existing file must have that etag, or * a Gio::Error with WRONG_ETAG will be thrown. - * + * * If @a make_backup is <tt>true</tt>, this function will attempt to make a backup of the file. - * + * * The returned @a new_etag can be used to verify that the file hasn't changed the * next time it is saved over. * @param contents A string containing the new contents for the file. * @param length The length of @a contents in bytes. - * @param etag The old entity tag + * @param etag The old entity tag * for the document. * @param make_backup <tt>true</tt> if a backup should be created. * @param flags A set of FileCreateFlags. @@ -2057,20 +2057,20 @@ public: void replace_contents(const char* contents, gsize length, const std::string& etag, std::string& new_etag, bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE); /** Replaces the contents of the file with @a contents. - * + * * If @a etag is specified (not an empty string) any existing file must have that etag, or * a Gio::Error with WRONG_ETAG will be thrown. - * + * * If @a make_backup is <tt>true</tt>, this function will attempt to make a backup of the file. - * + * * The operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, a Gio::Error with CANCELLED will be thrown. - * + * was cancelled, a Gio::Error with CANCELLED will be thrown. + * * The returned @a new_etag can be used to verify that the file hasn't changed the * next time it is saved over. * @param contents A string containing the new contents for the file. - * @param etag The old entity tag + * @param etag The old entity tag * for the document. * @param make_backup <tt>true</tt> if a backup should be created. * @param flags A set of FileCreateFlags. @@ -2081,16 +2081,16 @@ public: void replace_contents(const std::string& contents, const std::string& etag, std::string& new_etag, const Glib::RefPtr<Cancellable>& cancellable, bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE); /** Replaces the contents of the file with @a contents. - * + * * If @a etag is specified (not an empty string) any existing file must have that etag, or * a Gio::Error with WRONG_ETAG will be thrown. - * + * * If @a make_backup is <tt>true</tt>, this function will attempt to make a backup of the file. - * + * * The returned @a new_etag can be used to verify that the file hasn't changed the * next time it is saved over. * @param contents A string containing the new contents for the file. - * @param etag The old entity tag + * @param etag The old entity tag * for the document. * @param make_backup <tt>true</tt> if a backup should be created. * @param flags A set of FileCreateFlags. @@ -2104,18 +2104,18 @@ public: //TODO: Add replace_contents() without the etags? - /** Starts an asynchronous replacement of the file with the given - * @a contents of @a length bytes. @a etag will replace the document's + /** Starts an asynchronous replacement of the file with the given + * @a contents of @a length bytes. @a etag will replace the document's * current entity tag. - * - * When this operation has completed, @a slot will be called + * + * When this operation has completed, @a slot will be called * and the operation can be finalized with replace_contents_finish(). - * + * * The operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, a Gio::Error with CANCELLED will be thrown. - * - * If @a make_backup is true, this function will attempt to + * was cancelled, a Gio::Error with CANCELLED will be thrown. + * + * If @a make_backup is true, this function will attempt to * make a backup of the file. * * @param slot: A callback to call when the request is satisfied. @@ -2128,14 +2128,14 @@ public: */ void replace_contents_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, const char* contents, gsize length, const std::string& etag, bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE); - /** Starts an asynchronous replacement of the file with the given - * @a contents of @a length bytes. @a etag will replace the document's + /** Starts an asynchronous replacement of the file with the given + * @a contents of @a length bytes. @a etag will replace the document's * current entity tag. - * - * When this operation has completed, @a slot will be called + * + * When this operation has completed, @a slot will be called * and the operation can be finalized with replace_contents_finish(). - * - * If @a make_backup is true, this function will attempt to + * + * If @a make_backup is true, this function will attempt to * make a backup of the file. * * @param slot: A callback to call when the request is satisfied. @@ -2147,18 +2147,18 @@ public: */ void replace_contents_async(const SlotAsyncReady& slot, const char* contents, gsize length, const std::string& etag, bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE); - /** Starts an asynchronous replacement of the file with the given - * @a contents of @a length bytes. @a etag will replace the document's + /** Starts an asynchronous replacement of the file with the given + * @a contents of @a length bytes. @a etag will replace the document's * current entity tag. - * - * When this operation has completed, @a slot will be called + * + * When this operation has completed, @a slot will be called * and the operation can be finalized with replace_contents_finish(). - * + * * The operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, a Gio::Error with CANCELLED will be thrown. - * - * If @a make_backup is true, this function will attempt to + * was cancelled, a Gio::Error with CANCELLED will be thrown. + * + * If @a make_backup is true, this function will attempt to * make a backup of the file. * * @param slot: A callback to call when the request is satisfied. @@ -2170,18 +2170,18 @@ public: */ void replace_contents_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, const std::string& contents, const std::string& etag, bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE); - /** Starts an asynchronous replacement of the file with the given - * @a contents. @a etag will replace the document's + /** Starts an asynchronous replacement of the file with the given + * @a contents. @a etag will replace the document's * current entity tag. - * - * When this operation has completed, @a slot will be called + * + * When this operation has completed, @a slot will be called * and the operation can be finalized with replace_contents_finish(). - * + * * The operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, a Gio::Error with CANCELLED will be thrown. - * - * If @a make_backup is true, this function will attempt to + * was cancelled, a Gio::Error with CANCELLED will be thrown. + * + * If @a make_backup is true, this function will attempt to * make a backup of the file. * * @param slot: A callback to call when the request is satisfied. @@ -2195,16 +2195,16 @@ public: _IGNORE(g_file_replace_contents_async) /** Finishes an asynchronous replace of the given file . See - * replace_contents_async(). Sets @a new_etag to the new entity + * replace_contents_async(). Sets @a new_etag to the new entity * tag for the document. * @param result A AsyncResult. - * @param new_etag A location of a new entity tag + * @param new_etag A location of a new entity tag * for the document. */ void replace_contents_finish(const Glib::RefPtr<AsyncResult>& result, std::string& etag); /** Finishes an asynchronous replace of the given file . See - * replace_contents_async(). Sets @a new_etag to the new entity + * replace_contents_async(). Sets @a new_etag to the new entity * tag for the document. * @param result A AsyncResult. * for the document. @@ -2259,11 +2259,11 @@ Glib::RefPtr<Gio::File> wrap(GFile* object, bool take_copy); namespace Container_Helpers { -/** This specialization of TypeTraits exists - * because the default use of Glib::wrap(GObject*), +/** This specialization of TypeTraits exists + * because the default use of Glib::wrap(GObject*), * instead of a specific Glib::wrap(GSomeInterface*), * would not return a wrapper for an interface. - */ + */ template <> struct TypeTraits< Glib::RefPtr<Gio::File> > { @@ -2276,7 +2276,7 @@ struct TypeTraits< Glib::RefPtr<Gio::File> > static CppType to_cpp_type (const CType& item) { - //Use a specific Glib::wrap() function, + //Use a specific Glib::wrap() function, //because CType has the specific type (not just GObject): return Glib::wrap(item, true /* take_copy */); } diff --git a/gio/src/fileattributeinfolist.hg b/gio/src/fileattributeinfolist.hg index 5bbd25aa..dc3903aa 100644 --- a/gio/src/fileattributeinfolist.hg +++ b/gio/src/fileattributeinfolist.hg @@ -27,18 +27,18 @@ namespace Gio /** Key-Value paired file attributes. * File attributes in GIO consist of a list of key-value pairs. * - * Keys are strings that contain a key namespace and a key name, separated by a colon, e.g. "namespace:keyname". - * Namespaces are included to sort key-value pairs by namespaces for relevance. Keys can be retreived using wildcards, + * Keys are strings that contain a key namespace and a key name, separated by a colon, e.g. "namespace:keyname". + * Namespaces are included to sort key-value pairs by namespaces for relevance. Keys can be retreived using wildcards, * e.g. "standard::*" will return all of the keys in the "standard" namespace. * - * Values are stored within the list in Gio::FileAttributeValue structures. Values can store different types, listed in the enum + * Values are stored within the list in Gio::FileAttributeValue structures. Values can store different types, listed in the enum * Gio::FileAttributeType. Upon creation of a Gio::FileAttributeValue, the type will be set to Gio::FILE_ATTRIBUTE_TYPE_INVALID. * - * The list of possible attributes for a filesystem (pointed to by a Gio::File) is availible as a Gio::FileAttributeInfoList. + * The list of possible attributes for a filesystem (pointed to by a Gio::File) is availible as a Gio::FileAttributeInfoList. * This list is queryable by key names as indicated earlier. * - * Classes that implement Gio::FileIface will create a Gio::FileAttributeInfoList and install default keys and values for their given file - * system, architecture, and other possible implementation details (e.g., on a UNIX system, a file attribute key will be registered for + * Classes that implement Gio::FileIface will create a Gio::FileAttributeInfoList and install default keys and values for their given file + * system, architecture, and other possible implementation details (e.g., on a UNIX system, a file attribute key will be registered for * the user id for a given file). * * See http://library.gnome.org/devel/gio/unstable/gio-GFileAttribute.html for the list of default namespaces and the list of default keys. @@ -64,7 +64,7 @@ public: */ bool empty() const; - /** Gets the file attribute with the name name from list. + /** Gets the file attribute with the name name from list. * @param name The name of the attribute to lookup. * @result A FileAttributeInfo for the name. */ diff --git a/gio/src/fileenumerator.hg b/gio/src/fileenumerator.hg index 439971f8..85cb75ef 100644 --- a/gio/src/fileenumerator.hg +++ b/gio/src/fileenumerator.hg @@ -37,14 +37,14 @@ class File; //TODO: Consider wrapping this like a std::iterator (or at least renaming it), though the asyncness probably makes that unsuitable. /** Enumerated Files Routines. - * FileEnumerator allows you to operate on a set of Gio::Files, returning a Gio::FileInfo instance for each file enumerated + * FileEnumerator allows you to operate on a set of Gio::Files, returning a Gio::FileInfo instance for each file enumerated * (e.g. Gio::File::enumerate_children() will return a FileEnumerator for each of the children within a directory). * - * To get the next file's information from a Gio::FileEnumerator, use next_file() or its asynchronous version, next_file_async(). - * Note that the asynchronous version will return a list of Gio::FileInfos, whereas the synchronous version will only return the next + * To get the next file's information from a Gio::FileEnumerator, use next_file() or its asynchronous version, next_file_async(). + * Note that the asynchronous version will return a list of Gio::FileInfos, whereas the synchronous version will only return the next * file in the enumerator. * - * To close a Gio::FileEnumerator, use FileEnumerator::close(), or its asynchronous version, close_async(). Once a FileEnumerator is closed, + * To close a Gio::FileEnumerator, use FileEnumerator::close(), or its asynchronous version, close_async(). Once a FileEnumerator is closed, * no further actions may be performed on it. * * @newin{2,16} @@ -63,16 +63,16 @@ public: errthrow) - /** Request information for a number of files from the enumerator asynchronously. + /** Request information for a number of files from the enumerator asynchronously. * When all I/O for the operation is finished the callback slot will be called with the requested information. * - * The callback could be called with less than num_files files in case of error or at the end of the enumerator. - * In case of a partial error the callback will be called with any succeeding items and no error, and on the next request the error will be reported. + * The callback could be called with less than num_files files in case of error or at the end of the enumerator. + * In case of a partial error the callback will be called with any succeeding items and no error, and on the next request the error will be reported. * If a request is cancelled the callback will be called with ERROR_CANCELLED. * * During an async request no other sync and async calls are allowed, and will result in ERROR_PENDING errors. * - * Any outstanding I/O request with higher priority (lower numerical value) will be executed before an outstanding request with lower priority. + * Any outstanding I/O request with higher priority (lower numerical value) will be executed before an outstanding request with lower priority. * The default priority is PRIORITY_DEFAULT. * @param slot A callback to call when the request is satisfied. * @param cancellable An cancellable object which can be used to cancel the request. @@ -81,16 +81,16 @@ public: */ void next_files_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, int num_files = 1, int io_priority = Glib::PRIORITY_DEFAULT); - /** Request information for a number of files from the enumerator asynchronously. + /** Request information for a number of files from the enumerator asynchronously. * When all I/O for the operation is finished the callback slot will be called with the requested information. * - * The callback could be called with less than num_files files in case of error or at the end of the enumerator. - * In case of a partial error the callback will be called with any succeeding items and no error, and on the next request the error will be reported. + * The callback could be called with less than num_files files in case of error or at the end of the enumerator. + * In case of a partial error the callback will be called with any succeeding items and no error, and on the next request the error will be reported. * If a request is cancelled the callback will be called with ERROR_CANCELLED. * * During an async request no other sync and async calls are allowed, and will result in ERROR_PENDING errors. * - * Any outstanding I/O request with higher priority (lower numerical value) will be executed before an outstanding request with lower priority. + * Any outstanding I/O request with higher priority (lower numerical value) will be executed before an outstanding request with lower priority. * The default priority is PRIORITY_DEFAULT. * @param slot A callback to call when the request is satisfied. * @param num_files The number of file info objects to request. @@ -110,7 +110,7 @@ public: * * See close(), which is the synchronous version of this function. * - * The operation can be cancelled by triggering the cancellable object from another thread. + * The operation can be cancelled by triggering the cancellable object from another thread. * If the operation was cancelled, a Gio::Error with CANCELLED will be thrown by close_finish(). * * @param io_priority The I/O priority of the request. diff --git a/gio/src/fileinputstream.hg b/gio/src/fileinputstream.hg index 08d56266..476e3916 100644 --- a/gio/src/fileinputstream.hg +++ b/gio/src/fileinputstream.hg @@ -31,7 +31,7 @@ namespace Gio /** FileInputStream provides input streams that take their content from a file. * - * FileInputStream implements Seekable, which allows the input stream to jump to arbitrary positions in the file, + * FileInputStream implements Seekable, which allows the input stream to jump to arbitrary positions in the file, * provided the file system of the file allows it. * Use the methods of the Seekable base class for seeking and positioning. * @@ -39,8 +39,8 @@ namespace Gio * * @newin{2,16} */ -class FileInputStream -: public Gio::InputStream, +class FileInputStream +: public Gio::InputStream, public Seekable { _CLASS_GOBJECT(FileInputStream, GFileInputStream, G_FILE_INPUT_STREAM, Gio::InputStream, GInputStream) @@ -48,10 +48,10 @@ class FileInputStream public: - /** Queries a file input stream the given @a attributes. This function blocks - * while querying the stream. For the asynchronous (non-blocking) version - * of this function, see query_info_async(). While the - * stream is blocked, the stream will set the pending flag internally, and + /** Queries a file input stream the given @a attributes. This function blocks + * while querying the stream. For the asynchronous (non-blocking) 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. * * @param attributes A file attribute query string. @@ -60,10 +60,10 @@ public: */ Glib::RefPtr<FileInfo> query_info(const Glib::RefPtr<Cancellable>& cancellable, const std::string& attributes = "*"); - /** Queries a file input stream the given @a attributes. This function blocks - * while querying the stream. For the asynchronous (non-blocking) version - * of this function, see query_info_async(). While the - * stream is blocked, the stream will set the pending flag internally, and + /** Queries a file input stream the given @a attributes. This function blocks + * while querying the stream. For the asynchronous (non-blocking) 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. * * @param attributes A file attribute query string. @@ -75,7 +75,7 @@ public: /** Queries the stream information asynchronously. For the synchronous version of this function, see query_info(). * - * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, + * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, * a Gio::Error with CANCELLED will be thrown. * * When the operation is finished, @a slot will be called. You can then call query_info_finish() to get the result of the operation. diff --git a/gio/src/fileiostream.hg b/gio/src/fileiostream.hg index 474dd027..b015268b 100644 --- a/gio/src/fileiostream.hg +++ b/gio/src/fileiostream.hg @@ -29,7 +29,7 @@ namespace Gio /** FileIOStream provides input streams that take their content from a file. * - * FileInputStream implements Seekable, which allows the input stream to jump to arbitrary positions in the file, + * FileInputStream implements Seekable, which allows the input stream to jump to arbitrary positions in the file, * provided the file system of the file allows it. * Use the methods of the Seekable base class for seeking and positioning. * @@ -46,10 +46,10 @@ class FileIOStream public: - /** Queries a file input stream the given @a attributes. This function blocks - * while querying the stream. For the asynchronous (non-blocking) version - * of this function, see query_info_async(). While the - * stream is blocked, the stream will set the pending flag internally, and + /** Queries a file input stream the given @a attributes. This function blocks + * while querying the stream. For the asynchronous (non-blocking) 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. * * @param attributes A file attribute query string. @@ -58,10 +58,10 @@ public: */ Glib::RefPtr<FileInfo> query_info(const Glib::RefPtr<Cancellable>& cancellable, const std::string& attributes = "*"); - /** Queries a file input stream the given @a attributes. This function blocks - * while querying the stream. For the asynchronous (non-blocking) version - * of this function, see query_info_async(). While the - * stream is blocked, the stream will set the pending flag internally, and + /** Queries a file input stream the given @a attributes. This function blocks + * while querying the stream. For the asynchronous (non-blocking) 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. * * @param attributes A file attribute query string. @@ -73,7 +73,7 @@ public: /** Queries the stream information asynchronously. For the synchronous version of this function, see query_info(). * - * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, + * The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, * a Gio::Error with CANCELLED will be thrown. * * When the operation is finished, @a slot will be called. You can then call query_info_finish() to get the result of the operation. diff --git a/gio/src/filemonitor.hg b/gio/src/filemonitor.hg index fbbc851c..d5663d44 100644 --- a/gio/src/filemonitor.hg +++ b/gio/src/filemonitor.hg @@ -32,10 +32,10 @@ _WRAP_ENUM(FileMonitorEvent, GFileMonitorEvent, NO_GTYPE) class File; /** Monitors a file or directory for changes. - * To obtain a FileMonitor for a file or directory, use File::monitor_file() or + * To obtain a FileMonitor for a file or directory, use File::monitor_file() or * File::monitor_directory(). - * - * To get informed about changes to the file or directory you are monitoring, + * + * To get informed about changes to the file or directory you are monitoring, * connect to signal_changed(). * * @newin{2,16} @@ -46,7 +46,7 @@ class FileMonitor : public Glib::Object protected: public: - + _WRAP_METHOD(bool cancel(), g_file_monitor_cancel) _WRAP_METHOD(bool is_cancelled() const, g_file_monitor_is_cancelled) _WRAP_METHOD(void set_rate_limit(int limit_msecs), g_file_monitor_set_rate_limit) @@ -56,7 +56,7 @@ public: #m4 _CONVERSION(`GFile*',`const Glib::RefPtr<File>&',`Glib::wrap($3, true)') _WRAP_SIGNAL(void changed(const Glib::RefPtr<File>& file, const Glib::RefPtr<File>& other_file, FileMonitorEvent event_type), "changed") - + //_WRAP_VFUNC(bool cancel(), cancel); _WRAP_PROPERTY("rate-limit", int) diff --git a/gio/src/filenamecompleter.hg b/gio/src/filenamecompleter.hg index 39108562..773d3631 100644 --- a/gio/src/filenamecompleter.hg +++ b/gio/src/filenamecompleter.hg @@ -30,7 +30,7 @@ namespace Gio class File; -/** Completes partial file and directory names given a partial string by looking in the file system for clues. +/** Completes partial file and directory names given a partial string by looking in the file system for clues. * Can return a list of possible completion strings for widget implementation. * * @newin{2,16} @@ -45,7 +45,7 @@ public: _WRAP_CREATE() _WRAP_METHOD(std::string get_completion_suffix(const std::string& initial_text) const, g_filename_completer_get_completion_suffix) - + #m4 _CONVERSION(`char**',`Glib::StringArrayHandle',`Glib::StringArrayHandle($3, Glib::OWNERSHIP_DEEP)') _WRAP_METHOD(Glib::StringArrayHandle get_completions(const std::string& initial_text) const, g_filename_completer_get_completions) _WRAP_METHOD(void set_dirs_only(bool dirs_only = true), g_filename_completer_set_dirs_only) diff --git a/gio/src/fileoutputstream.hg b/gio/src/fileoutputstream.hg index 4295ea4c..0ba250a4 100644 --- a/gio/src/fileoutputstream.hg +++ b/gio/src/fileoutputstream.hg @@ -33,11 +33,11 @@ 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 + * 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. - * + * Use the methods of the Seekable base class for seeking and positioning. + * * @ingroup Streams * * @newin{2,16} @@ -51,21 +51,21 @@ class FileOutputStream 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 + /** 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 + * + * 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 + * 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 + * was cancelled, a Gio::Error with CANCELLED may be thrown, and an empty RefPtr will * be returned. * * @param cancellable A Cancellable object. @@ -74,21 +74,21 @@ public: */ Glib::RefPtr<FileInfo> query_info(const Glib::RefPtr<Cancellable>& cancellable, const std::string& attributes = "*"); - /** 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 + /** 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), + * + * 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 + * 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 + * was cancelled, a Gio::Error with CANCELLED may be thrown, and an empty RefPtr will * be returned. * * @param cancellable A Cancellable object. @@ -101,17 +101,17 @@ public: /** Queries the stream information asynchronously. - * When the operation is finished @a slot will be called. - * You can then call query_info_finish() + * 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(). - * + * For the synchronous version of this function, + * see query_info(). + * * 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. @@ -120,13 +120,13 @@ public: void query_info_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& 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() + * 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(). - * + * 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 <io-priority of the request. @@ -142,7 +142,7 @@ public: //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, + _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) diff --git a/gio/src/filterinputstream.hg b/gio/src/filterinputstream.hg index db2050b4..6d09e4dc 100644 --- a/gio/src/filterinputstream.hg +++ b/gio/src/filterinputstream.hg @@ -27,8 +27,8 @@ namespace Gio { /** Filter Input Stream. - * This is a base class for input stream implementations that perform some kind of filtering operation on a base stream. - & Typical examples of filtering operations are character set conversion, compression and byte order flipping. + * This is a base class for input stream implementations that perform some kind of filtering operation on a base stream. + & Typical examples of filtering operations are character set conversion, compression and byte order flipping. * * @ingroup Streams * diff --git a/gio/src/filteroutputstream.hg b/gio/src/filteroutputstream.hg index bb8d3cbf..47b5e013 100644 --- a/gio/src/filteroutputstream.hg +++ b/gio/src/filteroutputstream.hg @@ -28,8 +28,8 @@ namespace Gio /** Filter Output Stream. * - * This is a base class for output stream implementations that perform some kind of filtering operation on a base stream. - * Typical examples of filtering operations are character set conversion, compression and byte order flipping. + * This is a base class for output stream implementations that perform some kind of filtering operation on a base stream. + * Typical examples of filtering operations are character set conversion, compression and byte order flipping. * * @ingroup Streams * diff --git a/gio/src/icon.hg b/gio/src/icon.hg index b6d78e67..97ef3479 100644 --- a/gio/src/icon.hg +++ b/gio/src/icon.hg @@ -30,7 +30,7 @@ namespace Gio { /** This is a very minimal interface for icons. It provides functions for checking the equality of two icons and hashing of icons. - * Glib::Icon does not provide the actual pixmap for the icon as this is out of GIO's scope. However implementations of Icon may contain the name of an + * Glib::Icon does not provide the actual pixmap for the icon as this is out of GIO's scope. However implementations of Icon may contain the name of an * icon (see ThemedIcon), or the path to an icon (see LoadableIcon). * * To obtain a hash of an Icon instance, see hash(). diff --git a/gio/src/inputstream.hg b/gio/src/inputstream.hg index ba55fa29..7065303d 100644 --- a/gio/src/inputstream.hg +++ b/gio/src/inputstream.hg @@ -66,12 +66,12 @@ public: //TODO: Why not use _WRAP_METHOD() for this? /** Request an asynchronous read of @a count bytes from the stream into a - * new Glib::Bytes. When the operation is finished @a slot will be called. - * You can then call read_bytes_finish() to get the result of the + * new Glib::Bytes. When the operation is finished @a slot will be called. + * You can then call read_bytes_finish() to get the result of the * operation. * * During an async request no other sync and async calls are allowed, and will - * result in Gio::Error with PENDING being thrown. + * result in Gio::Error with PENDING being thrown. * * A value of @a count larger than MAXSSIZE will cause a Gio::Error with INVALID_ARGUMENT to be thrown. * @@ -95,12 +95,12 @@ public: void read_bytes_async(gsize count, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, int io_priority = Glib::PRIORITY_DEFAULT); /** Request an asynchronous read of @a count bytes from the stream into a - * new Glib::Bytes. When the operation is finished @a slot will be called. - * You can then call read_bytes_finish() to get the result of the + * new Glib::Bytes. When the operation is finished @a slot will be called. + * You can then call read_bytes_finish() to get the result of the * operation. * * During an async request no other sync and async calls are allowed, and will - * result in Gio::Error with PENDING being thrown. + * result in Gio::Error with PENDING being thrown. * * A value of @a count larger than MAXSSIZE will cause a Gio::Error with INVALID_ARGUMENT to be thrown. * @@ -137,12 +137,12 @@ public: /** Request an asynchronous read of @a count bytes from the stream into the buffer - * starting at @a buffer. When the operation is finished @a slot will be called. - * You can then call read_finish() to get the result of the + * starting at @a buffer. When the operation is finished @a slot will be called. + * You can then call read_finish() to get the result of the * operation. * * During an async request no other sync and async calls are allowed, and will - * result in Gio::Error with PENDING being thrown. + * result in Gio::Error with PENDING being thrown. * * A value of @a count larger than MAXSSIZE will cause a Gio::Error with INVALID_ARGUMENT to be thrown. * @@ -169,12 +169,12 @@ public: void read_async(void* buffer, gsize count, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, int io_priority = Glib::PRIORITY_DEFAULT); /** Request an asynchronous read of @a count bytes from the stream into the buffer - * starting at @a buffer. When the operation is finished @a slot will be called. - * You can then call read_finish() to get the result of the + * starting at @a buffer. When the operation is finished @a slot will be called. + * You can then call read_finish() to get the result of the * operation. * * During an async request no other sync and async calls are allowed, and will - * result in a Gio::Error with PENDING being thrown. + * result in a Gio::Error with PENDING being thrown. * * A value of @a count larger than MAXSSIZE will cause a Gio::Error with INVALID_ARGUMENT to be thrown. * @@ -195,7 +195,7 @@ public: * @param buffer A buffer to read data into (which should be at least count bytes long). * @param count The number of bytes that will be read from the stream. * @param slot Callback to call when the request is satisfied. - * @param io_priority The I/O priority of the request. + * @param io_priority The I/O priority of the request. */ void read_async(void* buffer, gsize count, const SlotAsyncReady& slot, int io_priority = Glib::PRIORITY_DEFAULT); _IGNORE(g_input_stream_read_async) @@ -207,11 +207,11 @@ public: //TODO: Use std::size_type instead of gsize? /** Request an asynchronous skip of @a count bytes from the stream into the buffer - * starting at @a buffer. When the operation is finished @a slot will be called. + * starting at @a buffer. When the operation is finished @a slot will be called. * You can then call skip_finish() to get the result of the operation. * * During an async request no other sync and async calls are allowed, and will - * result in Gio::Error with PENDING being thrown. + * result in Gio::Error with PENDING being thrown. * * A value of @a count larger than MAXSSIZE will cause a Gio::Error with INVALID_ARGUMENT to be thrown. * @@ -232,16 +232,16 @@ public: * @param count The number of bytes that will be skipped from the stream. * @param slot Callback to call when the request is satisfied. * @param cancellable A Cancellable object. - * @param io_priority The I/O priority of the request. + * @param io_priority The I/O priority of the request. */ void skip_async(gsize count, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, int io_priority = Glib::PRIORITY_DEFAULT); /** Request an asynchronous skip of @a count bytes from the stream into the buffer - * starting at @a buffer. When the operation is finished @a slot will be called. + * starting at @a buffer. When the operation is finished @a slot will be called. * You can then call skip_finish() to get the result of the operation. * * During an async request no other sync and async calls are allowed, and will - * result in Gio::Error with PENDING being thrown. + * result in Gio::Error with PENDING being thrown. * * A value of @a count larger than MAXSSIZE will cause a Gio::Error with INVALID_ARGUMENT to be thrown. * @@ -261,7 +261,7 @@ public: * * @param count The number of bytes that will be skipped from the stream. * @param slot Callback to call when the request is satisfied. - * @param io_priority The I/O priority of the request. + * @param io_priority The I/O priority of the request. */ void skip_async(gsize count, const SlotAsyncReady& slot, int io_priority = Glib::PRIORITY_DEFAULT); _IGNORE(g_input_stream_skip_async) @@ -271,8 +271,8 @@ public: errthrow) /** Requests an asynchronous closes of the stream, releasing resources related to it. - * When the operation is finished @a slot will be called. - * You can then call close_finish() to get the result of the + * When the operation is finished @a slot will be called. + * You can then call close_finish() to get the result of the * operation. * * For behaviour details see close(). @@ -283,13 +283,13 @@ public: * * @param slot Callback to call when the request is satisfied. * @param cancellable A Cancellable object. - * @param io_priority The I/O priority of the request. + * @param io_priority The I/O priority of the request. */ void close_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, int io_priority = Glib::PRIORITY_DEFAULT); /** Requests an asynchronous closes of the stream, releasing resources related to it. - * When the operation is finished @a slot will be called. - * You can then call close_finish() to get the result of the + * When the operation is finished @a slot will be called. + * You can then call close_finish() to get the result of the * operation. * * For behaviour details see close(). @@ -299,7 +299,7 @@ public: * override one you must override all. * * @param slot Callback to call when the request is satisfied. - * @param io_priority The I/O priority of the request. + * @param io_priority The I/O priority of the request. */ void close_async(const SlotAsyncReady& slot, int io_priority = Glib::PRIORITY_DEFAULT); _IGNORE(g_input_stream_close_async) diff --git a/gio/src/iostream.hg b/gio/src/iostream.hg index 35f49221..dcd5a763 100644 --- a/gio/src/iostream.hg +++ b/gio/src/iostream.hg @@ -90,7 +90,7 @@ public: /// A non-cancellable version of splice_async(). void splice_async(const Glib::RefPtr<IOStream>& stream2, - const SlotAsyncReady& slot, + const SlotAsyncReady& slot, IOStreamSpliceFlags flags = Gio::IO_STREAM_SPLICE_NONE, int io_priority = Glib::PRIORITY_DEFAULT); diff --git a/gio/src/memoryoutputstream.hg b/gio/src/memoryoutputstream.hg index d44aa463..24147e32 100644 --- a/gio/src/memoryoutputstream.hg +++ b/gio/src/memoryoutputstream.hg @@ -31,7 +31,7 @@ namespace Gio /** Streaming output operations on memory chunks * - * This class uses arbitrary memory chunks as output for GIO streaming output operations. + * This class uses arbitrary memory chunks as output for GIO streaming output operations. * * @ingroup Streams * @@ -57,13 +57,13 @@ public: _WRAP_METHOD(gsize get_size() const, g_memory_output_stream_get_size) _WRAP_METHOD(gsize get_data_size() const, g_memory_output_stream_get_data_size) - + _WRAP_PROPERTY("data", void*) _WRAP_PROPERTY("data-size", gulong) //Too C-like: _WRAP_PROPERTY("destroy-function", void*) //Too C-like: _WRAP_PROPERTY("realloc-function" gpointer : Read / Write / Construct Only _WRAP_PROPERTY("size", gulong) - + }; } // namespace Gio diff --git a/gio/src/menuitem.ccg b/gio/src/menuitem.ccg index bf8e897a..221eaea9 100644 --- a/gio/src/menuitem.ccg +++ b/gio/src/menuitem.ccg @@ -22,7 +22,7 @@ namespace Gio void MenuItem::set_action_and_target(const Glib::ustring& action) { - g_menu_item_set_action_and_target_value(gobj(), action.c_str(), 0); + g_menu_item_set_action_and_target_value(gobj(), action.c_str(), 0); } } // namespace Gio diff --git a/gio/src/menuitem.hg b/gio/src/menuitem.hg index 51e5e84a..3798d5b8 100644 --- a/gio/src/menuitem.hg +++ b/gio/src/menuitem.hg @@ -42,7 +42,7 @@ public: _WRAP_CREATE(const Glib::ustring& label{?}, const Glib::RefPtr<MenuModel>& submenu) - + //TODO: GMenuItem * g_menu_item_new_section (const Glib::ustring& label, // const Glib::RefPtr<MenuModel>& section); @@ -63,7 +63,7 @@ public: // Ignore varargs function. _IGNORE(g_menu_item_get_attribute) - + //TODO: Rename this to unset_action_target() and deprecate this one. /** Unsets the target for the specified @a action. */ diff --git a/gio/src/mount.hg b/gio/src/mount.hg index fb529cfa..d50a4f1e 100644 --- a/gio/src/mount.hg +++ b/gio/src/mount.hg @@ -45,12 +45,12 @@ class Drive; class Volume; /** The Mount interface represents user-visible mounts. - * Mount is a "mounted" filesystem that you can access. Mounted is in quotes because it's not the same as a unix mount: + * Mount is a "mounted" filesystem that you can access. Mounted is in quotes because it's not the same as a unix mount: * it might be a gvfs mount, but you can still access the files on it if you use GIO. It might or might not be related to a volume object. * - * Unmounting a Mount instance is an asynchronous operation. For more information about asynchronous operations, see AsyncReady. - * To unmount a Mount instance, first call unmount(). The callback slot will be called when the operation has resolved (either with success or failure), - * and a AsyncReady structure will be passed to the callback. That callback should then call unmount_finish() with the AsyncReady data to see if the operation was completed successfully. + * Unmounting a Mount instance is an asynchronous operation. For more information about asynchronous operations, see AsyncReady. + * To unmount a Mount instance, first call unmount(). The callback slot will be called when the operation has resolved (either with success or failure), + * and a AsyncReady structure will be passed to the callback. That callback should then call unmount_finish() with the AsyncReady data to see if the operation was completed successfully. * * @ingroup Streams * @@ -99,8 +99,8 @@ public: /** Remounts a mount. * This is an asynchronous operation, and is finished by calling mount_finish() with the AsyncResult data returned in the callback slot. * - * Remounting is useful when some setting affecting the operation of the volume has been changed, as this may need a remount - * to take affect. While this is semantically equivalent with unmounting and then remounting, not all backends might need to + * Remounting is useful when some setting affecting the operation of the volume has been changed, as this may need a remount + * to take affect. While this is semantically equivalent with unmounting and then remounting, not all backends might need to * actually be unmounted. * * @param operation A mount operation. @@ -112,8 +112,8 @@ public: /** Remounts a mount. * This is an asynchronous operation, and is finished by calling mount_finish() with the AsyncResult data returned in the callback slot. * - * Remounting is useful when some setting affecting the operation of the volume has been changed, as this may need a remount - * to take affect. While this is semantically equivalent with unmounting and then remounting, not all backends might need to + * Remounting is useful when some setting affecting the operation of the volume has been changed, as this may need a remount + * to take affect. While this is semantically equivalent with unmounting and then remounting, not all backends might need to * actually be unmounted. * * @param operation A mount operation. @@ -122,9 +122,9 @@ public: void remount(const Glib::RefPtr<MountOperation>& operation, const SlotAsyncReady& slot, MountMountFlags flags = MOUNT_MOUNT_NONE); /** Remounts a mount. - * - * Remounting is useful when some setting affecting the operation of the volume has been changed, as this may need a remount - * to take affect. While this is semantically equivalent with unmounting and then remounting, not all backends might need to + * + * Remounting is useful when some setting affecting the operation of the volume has been changed, as this may need a remount + * to take affect. While this is semantically equivalent with unmounting and then remounting, not all backends might need to * actually be unmounted. * * @param operation A mount operation. @@ -132,9 +132,9 @@ public: void remount(const Glib::RefPtr<MountOperation>& operation, MountMountFlags flags = MOUNT_MOUNT_NONE); /** Remounts a mount, without user interaction. - * - * Remounting is useful when some setting affecting the operation of the volume has been changed, as this may need a remount - * to take affect. While this is semantically equivalent with unmounting and then remounting, not all backends might need to + * + * Remounting is useful when some setting affecting the operation of the volume has been changed, as this may need a remount + * to take affect. While this is semantically equivalent with unmounting and then remounting, not all backends might need to * actually be unmounted. */ void remount(MountMountFlags flags = MOUNT_MOUNT_NONE); @@ -159,10 +159,10 @@ public: /** Tries to guess the type of content stored on the mount. * Returns one or more textual identifiers of well-known content types (typically - * prefixed with "x-content/"), e.g. x-content/image-dcf for camera + * prefixed with "x-content/"), e.g. x-content/image-dcf for camera * memory cards. See the <ulink url="http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec">shared-mime-info</ulink> specification for more on x-content types. * - * This is an asynchronous operation, and is finished by calling + * This is an asynchronous operation, and is finished by calling * guess_content_type_finish(). * * @param slot A callback which will be called when the operation is completed or canceled. @@ -175,10 +175,10 @@ public: /** Tries to guess the type of content stored on the mount. * Returns one or more textual identifiers of well-known content types (typically - * prefixed with "x-content/"), e.g. x-content/image-dcf for camera + * prefixed with "x-content/"), e.g. x-content/image-dcf for camera * memory cards. See the <ulink url="http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec">shared-mime-info</ulink> specification for more on x-content types. * - * This is an asynchronous operation, and is finished by calling + * This is an asynchronous operation, and is finished by calling * guess_content_type_finish(). * * @param slot A callback which will be called when the operation is completed or canceled. @@ -190,7 +190,7 @@ public: /** Tries to guess the type of content stored on the mount. * Returns one or more textual identifiers of well-known content types (typically - * prefixed with "x-content/"), e.g. x-content/image-dcf for camera + * prefixed with "x-content/"), e.g. x-content/image-dcf for camera * memory cards. See the <ulink url="http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec">shared-mime-info</ulink> specification for more on x-content types. * * @param force_rescan Whether to force a rescan of the content. Otherwise a cached result will be used if available. @@ -235,11 +235,11 @@ Glib::RefPtr<Gio::Mount> wrap(GMount* object, bool take_copy); namespace Container_Helpers { -/** This specialization of TypeTraits exists - * because the default use of Glib::wrap(GObject*), +/** This specialization of TypeTraits exists + * because the default use of Glib::wrap(GObject*), * instead of a specific Glib::wrap(GSomeInterface*), * would not return a wrapper for an interface. - */ + */ template <> struct TypeTraits< Glib::RefPtr<Gio::Mount> > { @@ -252,7 +252,7 @@ struct TypeTraits< Glib::RefPtr<Gio::Mount> > static CppType to_cpp_type (const CType& item) { - //Use a specific Glib::wrap() function, + //Use a specific Glib::wrap() function, //because CType has the specific type (not just GObject): return Glib::wrap(item, true /* take_copy */); } diff --git a/gio/src/mountoperation.hg b/gio/src/mountoperation.hg index 879aed2b..f57eb616 100644 --- a/gio/src/mountoperation.hg +++ b/gio/src/mountoperation.hg @@ -34,9 +34,9 @@ _WRAP_ENUM(MountOperationResult, GMountOperationResult, NO_GTYPE) /** Authentication methods for mountable locations. * * MountOperation provides a mechanism for authenticating mountable operations, such as loop mounting files, hard drive partitions or server locations. - * - * Mounting operations are handed a MountOperation that they can use if they require any privileges or authentication for their volumes to be mounted (e.g. - * a hard disk partition or an encrypted filesystem), or if they are implementing a remote server protocol which requires user credentials such as FTP or + * + * Mounting operations are handed a MountOperation that they can use if they require any privileges or authentication for their volumes to be mounted (e.g. + * a hard disk partition or an encrypted filesystem), or if they are implementing a remote server protocol which requires user credentials such as FTP or * WebDAV. * * Developers should instantiate a subclass of this that implements all the various callbacks to show the required dialogs. diff --git a/gio/src/outputstream.hg b/gio/src/outputstream.hg index fbfc6f15..3ba1aec2 100644 --- a/gio/src/outputstream.hg +++ b/gio/src/outputstream.hg @@ -48,16 +48,16 @@ public: /** Tries to write @a count bytes from @a buffer into the stream. Will block * during the operation. - * - * If count is zero returns zero and does nothing. A value of @a count + * + * If count is zero returns zero and does nothing. A value of @a count * larger than MAXSSIZE will cause a Gio::Error with INVALID_ARGUMENT to be thrown. - * + * * On success, the number of bytes written to the stream is returned. * It is not an error if this is not the same as the requested size, as it * can happen e.g. on a partial i/o error, or if the there is not enough * storage in the stream. All writes either block until at least one byte * is written, so zero is never returned (unless @a count is zero). - * + * * On error -1 is returned. * @param buffer The buffer containing the data to write. * @param cancellable Cancellable object. @@ -67,15 +67,15 @@ public: /** Tries to write @a count bytes from @a buffer into the stream. Will block * during the operation. - * + * * If string that is larger than MAXSSIZE bytes will cause a Gio::Error with INVALID_ARGUMENT to be thrown. - * + * * On success, the number of bytes written to the stream is returned. * It is not an error if this is not the same as the requested size, as it * can happen e.g. on a partial i/o error, or if the there is not enough * storage in the stream. All writes either block until at least one byte * is written, so zero is never returned (unless @a count is zero). - * + * * On error -1 is returned. * @param buffer The buffer containing the data to write. * @return Number of bytes written, or -1 on error. @@ -89,18 +89,18 @@ public: /** Tries to write @a count bytes from @a buffer into the stream. Will block * during the operation. - * + * * This function is similar to write(), except it tries to * write as many bytes as requested, only stopping on an error. - * - * On a successful write of @a count bytes, <tt>true</tt> is returned, and @a bytes_written + * + * On a successful write of @a count bytes, <tt>true</tt> is returned, and @a bytes_written * is set to @a count . - * - * If there is an error during the operation <tt>false</tt> is returned and @a error + * + * If there is an error during the operation <tt>false</tt> is returned and @a error * is set to indicate the error status, @a bytes_written is updated to contain * the number of bytes written into the stream before the error occured. * @param buffer The buffer containing the data to write. - * @param bytes_written Location to store the number of bytes that was + * @param bytes_written Location to store the number of bytes that was * written to the stream. * @param cancellable Cancellable object. * @return <tt>true</tt> on success, <tt>false</tt> if there was an error. @@ -109,18 +109,18 @@ public: /** Tries to write @a count bytes from @a buffer into the stream. Will block * during the operation. - * + * * This function is similar to write(), except it tries to * write as many bytes as requested, only stopping on an error. - * - * On a successful write of @a count bytes, <tt>true</tt> is returned, and @a bytes_written + * + * On a successful write of @a count bytes, <tt>true</tt> is returned, and @a bytes_written * is set to @a count . - * - * If there is an error during the operation <tt>false</tt> is returned and @a error + * + * If there is an error during the operation <tt>false</tt> is returned and @a error * is set to indicate the error status, @a bytes_written is updated to contain * the number of bytes written into the stream before the error occured. * @param buffer The buffer containing the data to write. - * @param bytes_written Location to store the number of bytes that was + * @param bytes_written Location to store the number of bytes that was * written to the stream. * @return <tt>true</tt> on success, <tt>false</tt> if there was an error. */ @@ -133,12 +133,12 @@ public: * then call write_bytes_finish() to get the result of * the operation. * - * During an async request no other sync and async calls are allowed, - * and will result in Gio::Error with PENDING being thrown. + * During an async request no other sync and async calls are allowed, + * and will result in Gio::Error with PENDING being thrown. * - * A Glib:Bytes larger than MAXSSIZE will cause a Gio::Error with + * A Glib:Bytes larger than MAXSSIZE will cause a Gio::Error with * INVALID_ARGUMENT to be thrown. - * + * * On success, the number of bytes written will be passed to the * callback @a slot. It is not an error if this is not the same as the * requested size, as it can happen e.g. on a partial I/O error, @@ -148,13 +148,13 @@ public: * IO_ERROR_WOULD_BLOCK - if the stream can't accept more data, the * method will just wait until this changes. * - * Any outstanding I/O request with higher priority (lower numerical - * value) will be executed before an outstanding request with lower + * Any outstanding I/O request with higher priority (lower numerical + * value) will be executed before an outstanding request with lower * priority. Default priority is Glib::PRIORITY_DEFAULT. - * + * * For the synchronous, blocking version of this function, see write_bytes(). * - * @param bytes The bytes to + * @param bytes The bytes to * @param slot Callback slot to call when the request is satisfied. * @param cancellable Cancellable object. * @param io_priority The io priority of the request. @@ -168,12 +168,12 @@ public: * then call write_bytes_finish() to get the result of * the operation. * - * During an async request no other sync and async calls are allowed, - * and will result in Gio::Error with PENDING being thrown. + * During an async request no other sync and async calls are allowed, + * and will result in Gio::Error with PENDING being thrown. * - * A Glib:Bytes larger than MAXSSIZE will cause a Gio::Error with + * A Glib:Bytes larger than MAXSSIZE will cause a Gio::Error with * INVALID_ARGUMENT to be thrown. - * + * * On success, the number of bytes written will be passed to the * callback @a slot. It is not an error if this is not the same as the * requested size, as it can happen e.g. on a partial I/O error, @@ -183,13 +183,13 @@ public: * IO_ERROR_WOULD_BLOCK - if the stream can't accept more data, the * method will just wait until this changes. * - * Any outstanding I/O request with higher priority (lower numerical - * value) will be executed before an outstanding request with lower + * Any outstanding I/O request with higher priority (lower numerical + * value) will be executed before an outstanding request with lower * priority. Default priority is Glib::PRIORITY_DEFAULT. - * + * * For the synchronous, blocking version of this function, see write_bytes(). * - * @param bytes The bytes to + * @param bytes The bytes to * @param slot Callback slot to call when the request is satisfied. * @param io_priority The io priority of the request. * @@ -228,34 +228,34 @@ public: g_output_stream_close, errthrow) - /** Request an asynchronous write of @a count bytes from @a buffer into - * the stream. When the operation is finished @a slot will be called. - * You can then call write_finish() to get the result of the + /** Request an asynchronous write of @a count bytes from @a buffer into + * the stream. When the operation is finished @a slot will be called. + * You can then call write_finish() to get the result of the * operation. * - * During an async request no other sync and async calls are allowed, - * and will result in Gio::Error with PENDING being thrown. + * During an async request no other sync and async calls are allowed, + * and will result in Gio::Error with PENDING being thrown. * - * A value of @a count larger than MAXSSIZE will cause a Gio::Error with + * A value of @a count larger than MAXSSIZE will cause a Gio::Error with * INVALID_ARGUMENT to be thrown. * * On success, the number of bytes written will be passed to the - * callback @a slot. It is not an error if this is not the same as the - * requested size, as it can happen e.g. on a partial I/O error, - * but generally we try to write as many bytes as requested. + * callback @a slot. It is not an error if this is not the same as the + * requested size, as it can happen e.g. on a partial I/O error, + * but generally we try to write as many bytes as requested. * - * Any outstanding I/O request with higher priority (lower numerical - * value) will be executed before an outstanding request with lower + * Any outstanding I/O request with higher priority (lower numerical + * value) will be executed before an outstanding request with lower * priority. Default priority is Glib::PRIORITY_DEFAULT. * - * The asyncronous methods have a default fallback that uses threads - * to implement asynchronicity, so they are optional for inheriting + * The asyncronous methods have a default fallback that uses threads + * to implement asynchronicity, so they are optional for inheriting * classes. However, if you override one you must override all. * - * For the synchronous, blocking version of this function, see + * For the synchronous, blocking version of this function, see * write(). * - * @param buffer The buffer containing the data to write. + * @param buffer The buffer containing the data to write. * @param count The number of bytes to write * @param slot Callback slot to call when the request is satisfied. * @param cancellable Cancellable object. @@ -263,34 +263,34 @@ public: */ void write_async(const void* buffer, gsize count, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, int io_priority = Glib::PRIORITY_DEFAULT); - /** Request an asynchronous write of @a count bytes from @a buffer into - * the stream. When the operation is finished @a slot will be called. - * You can then call write_finish() to get the result of the + /** Request an asynchronous write of @a count bytes from @a buffer into + * the stream. When the operation is finished @a slot will be called. + * You can then call write_finish() to get the result of the * operation. * - * During an async request no other sync and async calls are allowed, - * and will result in Gio::Error with PENDING being thrown. + * During an async request no other sync and async calls are allowed, + * and will result in Gio::Error with PENDING being thrown. * - * A value of @a count larger than MAXSSIZE will cause a Gio::Error with + * A value of @a count larger than MAXSSIZE will cause a Gio::Error with * INVALID_ARGUMENT to be thrown. * * On success, the number of bytes written will be passed to the - * callback @a slot. It is not an error if this is not the same as the - * requested size, as it can happen e.g. on a partial I/O error, - * but generally we try to write as many bytes as requested. + * callback @a slot. It is not an error if this is not the same as the + * requested size, as it can happen e.g. on a partial I/O error, + * but generally we try to write as many bytes as requested. * - * Any outstanding I/O request with higher priority (lower numerical - * value) will be executed before an outstanding request with lower + * Any outstanding I/O request with higher priority (lower numerical + * value) will be executed before an outstanding request with lower * priority. Default priority is Glib::PRIORITY_DEFAULT. * - * The asyncronous methods have a default fallback that uses threads - * to implement asynchronicity, so they are optional for inheriting + * The asyncronous methods have a default fallback that uses threads + * to implement asynchronicity, so they are optional for inheriting * classes. However, if you override one you must override all. * - * For the synchronous, blocking version of this function, see + * For the synchronous, blocking version of this function, see * write(). * - * @param buffer The buffer containing the data to write. + * @param buffer The buffer containing the data to write. * @param count The number of bytes to write * @param slot Callback slot to call when the request is satisfied. * @param io_priority The io priority of the request. @@ -303,11 +303,11 @@ public: errthrow) /** Splices a stream asynchronously. - * When the operation is finished @a slot will be called. - * You can then call splice_finish() to get the result of the + * When the operation is finished @a slot will be called. + * You can then call splice_finish() to get the result of the * operation. * - * For the synchronous, blocking version of this function, see + * For the synchronous, blocking version of this function, see * splice(). * * @param source An InputStream. @@ -318,11 +318,11 @@ public: void splice_async(const Glib::RefPtr<InputStream>& source, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, OutputStreamSpliceFlags flags = OUTPUT_STREAM_SPLICE_NONE, int io_priority = Glib::PRIORITY_DEFAULT); /** Splices a stream asynchronously. - * When the operation is finished @a slot will be called. - * You can then call splice_finish() to get the result of the + * When the operation is finished @a slot will be called. + * You can then call splice_finish() to get the result of the * operation. * - * For the synchronous, blocking version of this function, see + * For the synchronous, blocking version of this function, see * splice(). * * @param source An InputStream. @@ -363,12 +363,12 @@ public: g_output_stream_flush_finish, errthrow) - /** Requests an asynchronous close of the stream, releasing resources related to it. + /** Requests an asynchronous close of the stream, releasing resources related to it. * When the operation is finished the @a slot will be called, giving the results. * You can then call close_finish() to get the result of the operation. * For behaviour details see close(). * - * The asyncronous methods have a default fallback that uses threads to implement asynchronicity, + * The asyncronous methods have a default fallback that uses threads to implement asynchronicity, * so they are optional for inheriting classes. However, if you override one you must override all. * * @param slot Callback slot to call when the request is satisfied. @@ -377,12 +377,12 @@ public: */ void close_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, int io_priority = Glib::PRIORITY_DEFAULT); - /** Requests an asynchronous close of the stream, releasing resources related to it. - * When the operation is finished the @a slot will be called, giving the results. + /** Requests an asynchronous close of the stream, releasing resources related to it. + * When the operation is finished the @a slot will be called, giving the results. * You can then call close_finish() to get the result of the operation. * For behaviour details see close(). * - * The asyncronous methods have a default fallback that uses threads to implement asynchronicity, + * The asyncronous methods have a default fallback that uses threads to implement asynchronicity, * so they are optional for inheriting classes. However, if you override one you must override all. * * @param slot Callback slot to call when the request is satisfied. diff --git a/gio/src/proxy.ccg b/gio/src/proxy.ccg index 8f8a7cd4..232333e0 100644 --- a/gio/src/proxy.ccg +++ b/gio/src/proxy.ccg @@ -40,7 +40,7 @@ void Proxy::connect_async(const Glib::RefPtr<IOStream>& connection, const Glib:: &SignalProxy_async_callback, slot_copy); } - + void Proxy::connect_async(const Glib::RefPtr<IOStream>& connection, const Glib::RefPtr<const ProxyAddress>& proxy_address, const SlotAsyncReady& slot) { // Create a copy of the slot. diff --git a/gio/src/proxyresolver.ccg b/gio/src/proxyresolver.ccg index cec6b7ed..3fd2d6a8 100644 --- a/gio/src/proxyresolver.ccg +++ b/gio/src/proxyresolver.ccg @@ -51,7 +51,7 @@ void ProxyResolver::lookup_async(const Glib::ustring& uri, const SlotAsyncReady& &SignalProxy_async_callback, slot_copy); } - + void ProxyResolver::lookup_async(const Glib::ustring& uri, const SlotAsyncReady& slot) { // Create a copy of the slot. diff --git a/gio/src/resolver.hg b/gio/src/resolver.hg index 66ff18f4..b9b9b09c 100644 --- a/gio/src/resolver.hg +++ b/gio/src/resolver.hg @@ -60,8 +60,8 @@ public: #m4 _CONVERSION(`GList*',`Glib::ListHandle< Glib::RefPtr<InetAddress> >',`$2($3, Glib::OWNERSHIP_DEEP)') _WRAP_METHOD(Glib::ListHandle< Glib::RefPtr<InetAddress> > lookup_by_name(const Glib::ustring& hostname, const Glib::RefPtr<Cancellable>& cancellable{?}), g_resolver_lookup_by_name, errthrow) - - /** Begins asynchronously resolving hostname to determine its associated IP address(es), and eventually calls @a slot, which must call + + /** Begins asynchronously resolving hostname to determine its associated IP address(es), and eventually calls @a slot, which must call * lookup_by_name_finish() to get the result. See lookup_by_name() for more details. * * @param hostname hostname The hostname to look up. @@ -69,8 +69,8 @@ public: * @param cancellable A Cancellable object which can be used to cancel the operation. */ void lookup_by_name_async(const Glib::ustring& hostname, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable); - - /** Begins asynchronously resolving hostname to determine its associated IP address(es), and eventually calls @a slot, which must call + + /** Begins asynchronously resolving hostname to determine its associated IP address(es), and eventually calls @a slot, which must call * lookup_by_name_finish() to get the result. See lookup_by_name() for more details. * * @param hostname hostname The hostname to look up. @@ -78,12 +78,12 @@ public: */ void lookup_by_name_async(const Glib::ustring& hostname, const SlotAsyncReady& slot); _IGNORE(g_resolver_lookup_by_name_async) - + _WRAP_METHOD(Glib::ListHandle< Glib::RefPtr<InetAddress> > lookup_by_name_finish(const Glib::RefPtr<AsyncResult>& result), g_resolver_lookup_by_name_finish, errthrow) _WRAP_METHOD(Glib::ustring lookup_by_address(const Glib::RefPtr<InetAddress>& address, const Glib::RefPtr<Cancellable>& cancellable{?}), g_resolver_lookup_by_address, errthrow) - /** Begins asynchronously reverse-resolving an address to determine its associated hostname, and eventually calls callback, which must call + /** Begins asynchronously reverse-resolving an address to determine its associated hostname, and eventually calls callback, which must call * lookup_by_address_finish() to get the final result. * * @param address The address to reverse-resolve. @@ -92,8 +92,8 @@ public: * @param cancellable A Cancellable object which can be used to cancel the operation. */ void lookup_by_address_async(const Glib::RefPtr<InetAddress>& address, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable); - - /** Begins asynchronously reverse-resolving an address to determine its associated hostname, and eventually calls callback, which must call + + /** Begins asynchronously reverse-resolving an address to determine its associated hostname, and eventually calls callback, which must call * lookup_by_address_finish() to get the final result. * * @param address The address to reverse-resolve. @@ -102,28 +102,28 @@ public: */ void lookup_by_address_async(const Glib::RefPtr<InetAddress>& address, const SlotAsyncReady& slot); _IGNORE(g_resolver_lookup_by_address_async) - + _WRAP_METHOD(Glib::ustring lookup_by_address_finish(const Glib::RefPtr<AsyncResult>& result), g_resolver_lookup_by_address_finish, errthrow) #m4 _CONVERSION(`GList*',`ListHandle_SrvTarget',`$2($3, Glib::OWNERSHIP_DEEP)') _WRAP_METHOD(ListHandle_SrvTarget lookup_service(const Glib::ustring& service, const Glib::ustring& protocol, const Glib::ustring& domain, const Glib::RefPtr<Cancellable>& cancellable{?}), g_resolver_lookup_service, errthrow) - /** Begins asynchronously performing a DNS SRV lookup for the given service and protocol in the given domain, and eventually calls callback, + /** Begins asynchronously performing a DNS SRV lookup for the given service and protocol in the given domain, and eventually calls callback, * which must call lookup_service_finish() to get the final result. See glookup_service() for more details. * * @param service The service type to look up (eg, "ldap"). - * @param protocol The networking protocol to use for service (eg, "tcp") + * @param protocol The networking protocol to use for service (eg, "tcp") * @param domain The DNS domain to look up the service in. * @param slot A callback slot to call after the resolution completes. * @param cancellable A Cancellable object which can be used to cancel the operation. */ void lookup_service_async(const Glib::ustring& service, const Glib::ustring& protocol, const Glib::ustring& domain, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable); - - /** Begins asynchronously performing a DNS SRV lookup for the given service and protocol in the given domain, and eventually calls callback, + + /** Begins asynchronously performing a DNS SRV lookup for the given service and protocol in the given domain, and eventually calls callback, * which must call lookup_service_finish() to get the final result. See glookup_service() for more details. * * @param service The service type to look up (eg, "ldap"). - * @param protocol The networking protocol to use for service (eg, "tcp") + * @param protocol The networking protocol to use for service (eg, "tcp") * @param domain The DNS domain to look up the service in. * @param slot A callback slot to call after the resolution completes. */ diff --git a/gio/src/seekable.hg b/gio/src/seekable.hg index 941fd928..79c0d07c 100644 --- a/gio/src/seekable.hg +++ b/gio/src/seekable.hg @@ -34,10 +34,10 @@ namespace Gio /** Stream seeking interface. * Seekable is implemented by streams (implementations of InputStream or OutputStream) that support seeking. - * To find the position of a stream, use tell(). To find - * out if a stream supports seeking, use can_seek(). To position a - * stream, use seek(). To find out if a stream supports - * truncating, use can_truncate(). To truncate a stream, use + * To find the position of a stream, use tell(). To find + * out if a stream supports seeking, use can_seek(). To position a + * stream, use seek(). To find out if a stream supports + * truncating, use can_truncate(). To truncate a stream, use * truncate(). * * @ingroup Streams diff --git a/gio/src/socket.hg b/gio/src/socket.hg index 17eb6f9f..602d0452 100644 --- a/gio/src/socket.hg +++ b/gio/src/socket.hg @@ -178,7 +178,7 @@ public: _WRAP_METHOD(SocketProtocol get_protocol() const, g_socket_get_protocol) _WRAP_METHOD(SocketType get_socket_type() const, g_socket_get_socket_type) _WRAP_METHOD(bool speaks_ipv4() const, g_socket_speaks_ipv4) - + _WRAP_METHOD(Glib::RefPtr<Credentials> get_credentials(), g_socket_get_credentials, errthrow) _WRAP_METHOD(Glib::RefPtr<const Credentials> get_credentials() const, g_socket_get_credentials, errthrow) @@ -205,7 +205,7 @@ public: _WRAP_METHOD(bool join_multicast_group(const Glib::RefPtr<InetAddress>& group, bool source_specific, const std::string& iface{?}), g_socket_join_multicast_group, errthrow) _WRAP_METHOD(bool leave_multicast_group(const Glib::RefPtr<InetAddress>& ggroup, bool source_specific, const std::string& iface{?}), g_socket_leave_multicast_group, errthrow) - + _WRAP_PROPERTY("blocking", bool) _WRAP_PROPERTY("family", SocketFamily) _WRAP_PROPERTY("fd", int) diff --git a/gio/src/socketaddressenumerator.hg b/gio/src/socketaddressenumerator.hg index cf483d94..01a137ae 100644 --- a/gio/src/socketaddressenumerator.hg +++ b/gio/src/socketaddressenumerator.hg @@ -41,7 +41,7 @@ class SocketAddressEnumerator : public Glib::Object public: _WRAP_METHOD(Glib::RefPtr<SocketAddress> next(const Glib::RefPtr<Cancellable>& cancellable{?}), g_socket_address_enumerator_next, errthrow) - /** Asynchronously retrieves the next SocketAddress from the enumerator and then calls @a slot, + /** Asynchronously retrieves the next SocketAddress from the enumerator and then calls @a slot, * which must call next_finish() to get the result. * * @param cancellable A Cancellable object which can be used to cancel the operation. @@ -49,7 +49,7 @@ public: */ void next_async(const Glib::RefPtr<Cancellable>& cancellable, const SlotAsyncReady& slot); - /** Asynchronously retrieves the next SocketAddress from the enumerator and then calls @a slot, + /** Asynchronously retrieves the next SocketAddress from the enumerator and then calls @a slot, * which must call next_finish() to get the result. * * @param slot A callback slot to call after the resolution completes. diff --git a/gio/src/socketlistener.ccg b/gio/src/socketlistener.ccg index dd275599..b55c6055 100644 --- a/gio/src/socketlistener.ccg +++ b/gio/src/socketlistener.ccg @@ -30,10 +30,10 @@ bool SocketListener::add_socket(const Glib::RefPtr<Socket>& socket) Glib::unwrap(socket), 0, &gerror); - + if(gerror) ::Glib::Error::throw_exception(gerror); - + return retval; } @@ -128,7 +128,7 @@ Glib::RefPtr<Socket> SocketListener::accept_socket(Glib::RefPtr<Glib::Object>& s &gerror); if(gerror) ::Glib::Error::throw_exception(gerror); - + if(retobj) source_object = Glib::wrap(retobj); diff --git a/gio/src/socketlistener.hg b/gio/src/socketlistener.hg index 883f10de..9472e6ad 100644 --- a/gio/src/socketlistener.hg +++ b/gio/src/socketlistener.hg @@ -59,7 +59,7 @@ public: _WRAP_METHOD(bool add_socket(const Glib::RefPtr<Socket>& socket, const Glib::RefPtr<Glib::Object>& source_object), g_socket_listener_add_socket, errthrow) - //TODO: The use of WRAP_METHOD_DOCS_ONLY here is almost certainly not good enough. + //TODO: The use of WRAP_METHOD_DOCS_ONLY here is almost certainly not good enough. //Check the HTML actually outputed and probably hand-code them as for Gio::File. _WRAP_METHOD_DOCS_ONLY(g_socket_listener_add_socket) @@ -106,7 +106,7 @@ Glib::RefPtr<Socket> accept_socket(Glib::RefPtr<Glib::Object>& source_object, co _WRAP_METHOD_DOCS_ONLY(g_socket_listener_accept_socket_finish) Glib::RefPtr<Socket> accept_socket_finish(const Glib::RefPtr<AsyncResult>& result, Glib::RefPtr<Glib::Object>& source_object); _IGNORE(g_socket_listener_accept_socket_finish) - + _WRAP_METHOD_DOCS_ONLY(g_socket_listener_accept_socket_finish) Glib::RefPtr<Socket> accept_socket_finish(const Glib::RefPtr<AsyncResult>& result); diff --git a/gio/src/volume.ccg b/gio/src/volume.ccg index 2a7b6bd0..d06790a8 100644 --- a/gio/src/volume.ccg +++ b/gio/src/volume.ccg @@ -91,7 +91,7 @@ void Volume::eject(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& SlotAsyncReady* slot_copy = new SlotAsyncReady(slot); g_volume_eject_with_operation(gobj(), - static_cast<GMountUnmountFlags>(flags), + static_cast<GMountUnmountFlags>(flags), 0, // mount_operation Glib::unwrap(cancellable), &SignalProxy_async_callback, @@ -106,7 +106,7 @@ void Volume::eject(const SlotAsyncReady& slot, MountUnmountFlags flags) SlotAsyncReady* slot_copy = new SlotAsyncReady(slot); g_volume_eject_with_operation(gobj(), - static_cast<GMountUnmountFlags>(flags), + static_cast<GMountUnmountFlags>(flags), 0, // mount_operation 0, // cancellable &SignalProxy_async_callback, @@ -116,7 +116,7 @@ void Volume::eject(const SlotAsyncReady& slot, MountUnmountFlags flags) void Volume::eject(MountUnmountFlags flags) { g_volume_eject_with_operation(gobj(), - static_cast<GMountUnmountFlags>(flags), + static_cast<GMountUnmountFlags>(flags), 0, // mount_operation 0, // cancellable 0, // callback @@ -131,7 +131,7 @@ void Volume::eject(const Glib::RefPtr<MountOperation>& mount_operation, const Sl SlotAsyncReady* slot_copy = new SlotAsyncReady(slot); g_volume_eject_with_operation(gobj(), - static_cast<GMountUnmountFlags>(flags), + static_cast<GMountUnmountFlags>(flags), Glib::unwrap(mount_operation), Glib::unwrap(cancellable), &SignalProxy_async_callback, @@ -146,7 +146,7 @@ void Volume::eject(const Glib::RefPtr<MountOperation>& mount_operation, const Sl SlotAsyncReady* slot_copy = new SlotAsyncReady(slot); g_volume_eject_with_operation(gobj(), - static_cast<GMountUnmountFlags>(flags), + static_cast<GMountUnmountFlags>(flags), Glib::unwrap(mount_operation), 0, // cancellable &SignalProxy_async_callback, @@ -156,7 +156,7 @@ void Volume::eject(const Glib::RefPtr<MountOperation>& mount_operation, const Sl void Volume::eject(const Glib::RefPtr<MountOperation>& mount_operation, MountUnmountFlags flags) { g_volume_eject_with_operation(gobj(), - static_cast<GMountUnmountFlags>(flags), + static_cast<GMountUnmountFlags>(flags), Glib::unwrap(mount_operation), 0, // cancellable 0, // callback diff --git a/gio/src/volume.hg b/gio/src/volume.hg index 653a73a3..72329ef7 100644 --- a/gio/src/volume.hg +++ b/gio/src/volume.hg @@ -40,15 +40,15 @@ class File; class Drive; /** The Volume interface represents user-visible objects that can be mounted. - * - * Mounting a Volume instance is an asynchronous operation. For more information about asynchronous operations, see AsyncReady and SimpleAsyncReady. To + * + * Mounting a Volume instance is an asynchronous operation. For more information about asynchronous operations, see AsyncReady and SimpleAsyncReady. To * mount a GVolume, first call mount(), optionally providing a MountOperation object and a SlotAsyncReady callback. - * - * Typically, you will not want to provide a MountOperation if automounting all volumes when a desktop session starts since it's not desirable to + * + * Typically, you will not want to provide a MountOperation if automounting all volumes when a desktop session starts since it's not desirable to * put up a lot of dialogs asking for credentials. - * - * The callback will be fired when the operation has resolved (either with success or failure), and a AsyncReady structure will be passed to the callback. - * That callback should then call g_volume_mount_finish() with the GVolume instance and the GAsyncReady data to see if the operation was completed + * + * The callback will be fired when the operation has resolved (either with success or failure), and a AsyncReady structure will be passed to the callback. + * That callback should then call g_volume_mount_finish() with the GVolume instance and the GAsyncReady data to see if the operation was completed * successfully. If an error is present when finish() is called, then it will be filled with any error information. * * @newin{2,16} @@ -110,7 +110,7 @@ public: void mount(const Glib::RefPtr<MountOperation>& mount_operation, const SlotAsyncReady& slot, MountMountFlags flags = MOUNT_MOUNT_NONE); /** Mounts a volume. - * + * * @param mount_operation A mount operation. */ void mount(const Glib::RefPtr<MountOperation>& mount_operation, MountMountFlags flags = MOUNT_MOUNT_NONE); @@ -166,11 +166,11 @@ public: //_WRAP_VFUNC(bool can_mount(), can_mount) //_WRAP_VFUNC(bool can_eject(), can_eject) - //_WRAP_VFUNC(void mount_fn(GMountMountFlags flags, GMountOperation* mount_operation, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer user_data), mount_fn) //TODO: Rename to mount()? + //_WRAP_VFUNC(void mount_fn(GMountMountFlags flags, GMountOperation* mount_operation, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer user_data), mount_fn) //TODO: Rename to mount()? //_WRAP_VFUNC(bool mount_finish(GAsyncResult* result, GError** error), mount_finish) //_WRAP_VFUNC(void eject(GMountUnmountFlags flags, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer user_data), eject) //_WRAP_VFUNC(bool eject_finish(GAsyncResult* result, GError** error), eject_finish) - + //_WRAP_VFUNC(std::string get_identifier(const std::string& kind), get_identifier) //TODO: Use an ArrayHandle. @@ -190,11 +190,11 @@ Glib::RefPtr<Gio::Volume> wrap(GVolume* object, bool take_copy); namespace Container_Helpers { -/** This specialization of TypeTraits exists - * because the default use of Glib::wrap(GObject*), +/** This specialization of TypeTraits exists + * because the default use of Glib::wrap(GObject*), * instead of a specific Glib::wrap(GSomeInterface*), * would not return a wrapper for an interface. - */ + */ template <> struct TypeTraits< Glib::RefPtr<Gio::Volume> > { @@ -207,7 +207,7 @@ struct TypeTraits< Glib::RefPtr<Gio::Volume> > static CppType to_cpp_type (const CType& item) { - //Use a specific Glib::wrap() function, + //Use a specific Glib::wrap() function, //because CType has the specific type (not just GObject): return Glib::wrap(item, true /* take_copy */); } diff --git a/gio/src/volumemonitor.hg b/gio/src/volumemonitor.hg index 59881198..6e7cc1ad 100644 --- a/gio/src/volumemonitor.hg +++ b/gio/src/volumemonitor.hg @@ -33,8 +33,8 @@ namespace Gio { /** Monitors a file or directory for changes. - * VolumeMonitor is for listing the user-interesting devices and volumes on the - * computer. In other words, what a file selector or file manager would show in + * VolumeMonitor is for listing the user-interesting devices and volumes on the + * computer. In other words, what a file selector or file manager would show in * a sidebar. * * @newin{2,16} diff --git a/glib/glibmm/class.cc b/glib/glibmm/class.cc index 5f96ec4a..913b17da 100644 --- a/glib/glibmm/class.cc +++ b/glib/glibmm/class.cc @@ -53,7 +53,7 @@ void Class::register_derived_type(GType base_type, GTypeModule* module) //GTypeQuery::instance_size is guint but GTypeInfo::instance_size is guint16. const guint16 instance_size = (guint16)base_query.instance_size; - + const GTypeInfo derived_info = { class_size, @@ -75,7 +75,7 @@ void Class::register_derived_type(GType base_type, GTypeModule* module) } gchar* derived_name = g_strconcat("gtkmm__", base_query.type_name, (void*)0); - + if(module) gtype_ = g_type_module_register_type(module, base_type, derived_name, &derived_info, GTypeFlags(0)); else diff --git a/glib/glibmm/containerhandle_shared.h b/glib/glibmm/containerhandle_shared.h index cd338677..eb7e508b 100644 --- a/glib/glibmm/containerhandle_shared.h +++ b/glib/glibmm/containerhandle_shared.h @@ -42,10 +42,10 @@ namespace Glib /** * @ingroup ContHandles */ - + //! Ownership of the container -/*! Defines how and if the container will release the list and - * its elemens when it is destroyed +/*! Defines how and if the container will release the list and + * its elemens when it is destroyed */ enum OwnershipType { @@ -145,7 +145,7 @@ struct TypeTraits<T*> GObject* cobj = (GObject*)ptr; return dynamic_cast<CppType>(Glib::wrap_auto(cobj, false /* take_copy */)); } - + static void release_c_type (CType ptr) { GLIBMM_DEBUG_UNREFERENCE(0, ptr); @@ -154,7 +154,7 @@ struct TypeTraits<T*> }; //This confuse the SUN Forte compiler, so we ifdef it out: -#ifdef GLIBMM_HAVE_DISAMBIGUOUS_CONST_TEMPLATE_SPECIALIZATIONS +#ifdef GLIBMM_HAVE_DISAMBIGUOUS_CONST_TEMPLATE_SPECIALIZATIONS /** Partial specialization for pointers to const GtkObject instances. * @ingroup ContHelpers @@ -177,7 +177,7 @@ struct TypeTraits<const T*> GObject* cobj = (GObject*)const_cast<CTypeNonConst>(ptr); return dynamic_cast<CppType>(Glib::wrap_auto(cobj, false /* take_copy */)); } - + static void release_c_type (CType ptr) { GLIBMM_DEBUG_UNREFERENCE(0, ptr); @@ -211,7 +211,7 @@ struct TypeTraits< Glib::RefPtr<T> > return Glib::RefPtr<T>( dynamic_cast<T*>(Glib::wrap_auto(cobj, true /* take_copy */)) ); //We use dynamic_cast<> in case of multiple inheritance. } - + static void release_c_type (CType ptr) { GLIBMM_DEBUG_UNREFERENCE(0, ptr); @@ -247,7 +247,7 @@ struct TypeTraits< Glib::RefPtr<const T> > return Glib::RefPtr<const T>( dynamic_cast<const T*>(Glib::wrap_auto(cobj, true /* take_copy */)) ); //We use dynamic_cast<> in case of multiple inheritance. } - + static void release_c_type (CType ptr) { GLIBMM_DEBUG_UNREFERENCE(0, ptr); diff --git a/glib/glibmm/containers.h b/glib/glibmm/containers.h index 390879a2..7d78854b 100644 --- a/glib/glibmm/containers.h +++ b/glib/glibmm/containers.h @@ -61,7 +61,7 @@ public: typedef std::bidirectional_iterator_tag iterator_category; typedef std::size_t size_type; typedef std::ptrdiff_t difference_type; - + typedef typename List_Iterator_Base<T>::pointer pointer; typedef typename List_Iterator_Base<T>::reference reference; diff --git a/glib/glibmm/init.cc b/glib/glibmm/init.cc index 4bc5eacb..0710f3f4 100644 --- a/glib/glibmm/init.cc +++ b/glib/glibmm/init.cc @@ -27,7 +27,7 @@ namespace Glib void init() { Glib::wrap_register_init(); - Glib::Error::register_init(); //also calls Glib::wrap_init(); + Glib::Error::register_init(); //also calls Glib::wrap_init(); } } // namespace Glib diff --git a/glib/glibmm/interface.h b/glib/glibmm/interface.h index 43e529fc..2eec856c 100644 --- a/glib/glibmm/interface.h +++ b/glib/glibmm/interface.h @@ -41,18 +41,18 @@ public: typedef GTypeInterface BaseClassType; #endif /* DOXYGEN_SHOULD_SKIP_THIS */ - /** Called by constructors of derived classes. Provide the result of - * the Class object's init() function to ensure that it is properly + /** Called by constructors of derived classes. Provide the result of + * the Class object's init() function to ensure that it is properly * initialized. - * + * * @param interface_class The Class object for the derived type. */ explicit Interface(const Glib::Interface_Class& interface_class); /** Called by constructors of derived classes. - * - * @param cast_item A C instance that will be wrapped by the new - * C++ instance. This does not take a reference, so call reference() + * + * @param cast_item A C instance that will be wrapped by the new + * C++ instance. This does not take a reference, so call reference() * if necessary. */ explicit Interface(GObject* castitem); diff --git a/glib/glibmm/listhandle.h b/glib/glibmm/listhandle.h index 84c71b6c..e63bb0b0 100644 --- a/glib/glibmm/listhandle.h +++ b/glib/glibmm/listhandle.h @@ -150,10 +150,10 @@ private: //TODO: Remove this when we can break glibmm API. /** This is an intermediate type. When a method takes this, or returns this, you - * should use a standard C++ container of your choice, such as std::list or + * should use a standard C++ container of your choice, such as std::list or * std::vector. * - * However, this is not used in new API. We now prefer to just use std::vector, + * However, this is not used in new API. We now prefer to just use std::vector, * which is less flexibile, but makes the API clearer. * * @ingroup ContHandles diff --git a/glib/glibmm/object.h b/glib/glibmm/object.h index 9d48d933..4ac56a11 100644 --- a/glib/glibmm/object.h +++ b/glib/glibmm/object.h @@ -189,7 +189,7 @@ struct TypeTraits< Glib::RefPtr<T> > return Glib::RefPtr<T>( dynamic_cast<T*>(Glib::wrap_auto(cobj, true /* take_copy */)) ); //We use dynamic_cast<> in case of multiple inheritance. } - + static void release_c_type(CType ptr) { GLIBMM_DEBUG_UNREFERENCE(0, ptr); @@ -225,7 +225,7 @@ struct TypeTraits< Glib::RefPtr<const T> > return Glib::RefPtr<const T>( dynamic_cast<const T*>(Glib::wrap_auto(cobj, true /* take_copy */)) ); //We use dynamic_cast<> in case of multiple inheritance. } - + static void release_c_type (CType ptr) { GLIBMM_DEBUG_UNREFERENCE(0, ptr); @@ -261,7 +261,7 @@ public: CppType get() const { return Glib::RefPtr<T>::cast_dynamic(get_object_copy()); } }; -//The SUN Forte Compiler has a problem with this: +//The SUN Forte Compiler has a problem with this: # ifdef GLIBMM_HAVE_DISAMBIGUOUS_CONST_TEMPLATE_SPECIALIZATIONS /** Partial specialization for RefPtr<> to const Glib::Object. diff --git a/glib/glibmm/objectbase.cc b/glib/glibmm/objectbase.cc index 4798c1fc..7a2c377c 100644 --- a/glib/glibmm/objectbase.cc +++ b/glib/glibmm/objectbase.cc @@ -271,7 +271,7 @@ sigc::connection ObjectBase::connect_property_changed_with_return(const Glib::us // which will contain a switch/case statement which will examine the property name. const Glib::ustring notify_signal_name = "notify::" + property_name; pConnectionNode->connection_id_ = g_signal_connect_data(gobj(), - notify_signal_name.c_str(), (GCallback)(&PropertyProxyConnectionNode::callback), pConnectionNode, + notify_signal_name.c_str(), (GCallback)(&PropertyProxyConnectionNode::callback), pConnectionNode, &PropertyProxyConnectionNode::destroy_notify_handler, G_CONNECT_AFTER); diff --git a/glib/glibmm/objectbase.h b/glib/glibmm/objectbase.h index 69b77224..97f78f3f 100644 --- a/glib/glibmm/objectbase.h +++ b/glib/glibmm/objectbase.h @@ -55,7 +55,7 @@ protected: /** This default constructor is called implicitly from the constructor of user-derived * classes, even if, for instance, Gtk::Button calls a different ObjectBase constructor. * This is normal behaviour for C++ virtual inheritance. - * + * * The GType name will be gtkmm__anonymous_custom_type. */ ObjectBase(); @@ -63,7 +63,7 @@ protected: /** A derived constructor always overrides this choice. * The C++ language itself ensures that the constructor * is only invoked once. - * + * * All classes generated by gtkmmproc use this constructor, with custom_type_name = 0, * which essentially means it's not a custom type. This is used to optimize * vfunc and signal handler callbacks -- since the C++ virtual methods are @@ -104,17 +104,17 @@ public: template <class PropertyType> void get_property(const Glib::ustring& property_name, PropertyType& value) const; - /** You can use the signal_changed() signal of the property proxy instead, + /** You can use the signal_changed() signal of the property proxy instead, * but this is necessary when using the reduced API. * * See also connect_property_changed_with_return(). */ void connect_property_changed(const Glib::ustring& property_name, const sigc::slot<void>& slot); - /** You can use the signal_changed() signal of the property proxy instead, + /** You can use the signal_changed() signal of the property proxy instead, * but this is necessary when using the reduced API. * - * This method was added because connect_property_changed() does not return a sigc::connection, + * This method was added because connect_property_changed() does not return a sigc::connection, * and we could not break the ABI by changing that function. */ sigc::connection connect_property_changed_with_return(const Glib::ustring& property_name, const sigc::slot<void>& slot); @@ -128,7 +128,7 @@ public: */ void freeze_notify(); - /** + /** * Reverts the effect of a previous call to freeze_notify(). The freeze count * is decreased on object and when it reaches zero, all queued "notify" * signals are emitted. diff --git a/glib/glibmm/property.h b/glib/glibmm/property.h index 5878a941..3b2b422d 100644 --- a/glib/glibmm/property.h +++ b/glib/glibmm/property.h @@ -49,9 +49,9 @@ void custom_set_property_callback(GObject* object, unsigned int property_id, #endif /* DOXYGEN_SHOULD_SKIP_THIS */ /** This is the base class for Glib::Object properties. - * + * * This class manages the generic parts of the object properties. - * Derived (templated) classes handle the specific value types. + * Derived (templated) classes handle the specific value types. */ class PropertyBase { @@ -60,7 +60,7 @@ public: /** Returns the name of the property. */ Glib::ustring get_name() const; - + /** Notifies the object containing the property that the property has changed. * This emits the "notify" signal, passing the property name. */ @@ -72,7 +72,7 @@ protected: GParamSpec* param_spec_; /** This constructs a property of type @a value_type for the @a object. - * The property is not registered in the GObject object system + * The property is not registered in the GObject object system * until install_property() has been called. Derived classes do this in * their constructors. * @@ -86,7 +86,7 @@ protected: * Checks if the property has already been installed. */ bool lookup_property(const Glib::ustring& name); - + /** * Installs the property specified by the given @a param_spec. */ @@ -114,7 +114,7 @@ private: }; /** A Glib::Object property. - * + * * This class wraps a GObject property, providing a C++ API to the GObject property * system, for use with classes derived from Glib::Object or Glib::Interface. * @@ -125,15 +125,15 @@ private: * * A short description. * * The default value and the minimum and maximum bounds (depending on the type of the property). * * Flags, defining, among other things, whether the property can be read or written. - * + * * This Property class currently supports only the name and default value. The * minimum and maximum bounds are set to the full range of the value. The nick * and the explanation are set to empty. The flags are set to indicate that the * property can be both read from and written to. - * - * The class information must be installed into the GObject system once per + * + * The class information must be installed into the GObject system once per * property, but this is handled automatically. - * + * * A property can be used only as direct data member of a type, inheriting from * Glib::Object. A reference to the object must be passed to the constructor of * the property. @@ -149,7 +149,7 @@ public: * For each instance of the object, the same property must be constructed with the same name */ Property(Glib::Object& object, const Glib::ustring& name); - + /** Constructs a property of the @a object with the specified @a name and @a default_value. * For each instance of the object, the same property must be constructed with the same name. */ @@ -159,7 +159,7 @@ public: * The object containing the property will be notified about the change. */ inline void set_value(const PropertyType& data); - + /** Returns the value of the property. */ inline PropertyType get_value() const; @@ -168,7 +168,7 @@ public: * The object containing the property will be notified about the change. */ inline Property<T>& operator=(const PropertyType& data); - + /** Returns the value of the property. */ inline operator PropertyType() const; diff --git a/glib/glibmm/propertyproxy.h b/glib/glibmm/propertyproxy.h index 98093bec..a41f549a 100644 --- a/glib/glibmm/propertyproxy.h +++ b/glib/glibmm/propertyproxy.h @@ -39,9 +39,9 @@ namespace Glib * * You may also receive notification when a property's value changes, by connecting to signal_changed(). * - * You may register new properties for your class (actually for the underlying GType) + * You may register new properties for your class (actually for the underlying GType) * simply by adding a PropertyProxy instance as a class member. - * However, your constructor must call the Glib::ObjectBase constructor with a new GType name, + * However, your constructor must call the Glib::ObjectBase constructor with a new GType name, * in order to register a new GType. */ template <class T> @@ -149,7 +149,7 @@ T PropertyProxy<T>::get_value() const return value.get(); } -//We previously just static_cast<> PropertyProxy_WriteOnly<> to PropertyProxy<> to call its set_value(), +//We previously just static_cast<> PropertyProxy_WriteOnly<> to PropertyProxy<> to call its set_value(), //to avoid code duplication. //But the AIX compiler does not like that hack. template <class T> @@ -162,7 +162,7 @@ void PropertyProxy_WriteOnly<T>::set_value(const T& data) set_property_(value); } -//We previously just static_cast<> PropertyProxy_WriteOnly<> to PropertyProxy<> to call its set_value(), +//We previously just static_cast<> PropertyProxy_WriteOnly<> to PropertyProxy<> to call its set_value(), //to avoid code duplication. //But the AIX compiler does not like that hack. template <class T> diff --git a/glib/glibmm/quark.cc b/glib/glibmm/quark.cc index 73a4baaf..810ec344 100644 --- a/glib/glibmm/quark.cc +++ b/glib/glibmm/quark.cc @@ -25,7 +25,7 @@ namespace Glib { QueryQuark::QueryQuark(const GQuark& q) - : quark_(q) + : quark_(q) {} QueryQuark::QueryQuark(const ustring& s) diff --git a/glib/glibmm/quark.h b/glib/glibmm/quark.h index c0bdc814..472589f5 100644 --- a/glib/glibmm/quark.h +++ b/glib/glibmm/quark.h @@ -28,11 +28,11 @@ namespace Glib { -/** Quarks are unique IDs in Glib for strings for use in +/** Quarks are unique IDs in Glib for strings for use in * hash table lookups. Each Quark is unique but may change * between runs. * - * QueryQuark is a converter class for looking up but not + * QueryQuark is a converter class for looking up but not * allocating an ID. An id means the quark lookup failed. * * Quark is used for actions for which the id should live on diff --git a/glib/glibmm/refptr.h b/glib/glibmm/refptr.h index bd27b165..541a1bcf 100644 --- a/glib/glibmm/refptr.h +++ b/glib/glibmm/refptr.h @@ -55,7 +55,7 @@ public: * Afterwards it will be null and use of -> will cause a segmentation fault. */ inline RefPtr(); - + /// Destructor - decrements reference count. inline ~RefPtr(); @@ -94,7 +94,7 @@ public: /// Tests whether the RefPtr<> point to the same underlying instance. inline bool operator==(const RefPtr<T_CppObject>& src) const; - + /// See operator==(). inline bool operator!=(const RefPtr<T_CppObject>& src) const; @@ -137,7 +137,7 @@ public: /** Static cast to derived class. * - * Like the dynamic cast; the notation is + * Like the dynamic cast; the notation is * @code * ptr_derived = RefPtr<Derived>::cast_static(ptr_base); * @endcode @@ -155,7 +155,7 @@ public: template <class T_CastFrom> static inline RefPtr<T_CppObject> cast_const(const RefPtr<T_CastFrom>& src); - //TODO: Maybe remove these if we replace operator bool() with operator const void* after + //TODO: Maybe remove these if we replace operator bool() with operator const void* after //an API/ABI break, as suggested by Daniel Elstner? murrayc. //See bug https://bugzilla.gnome.org/show_bug.cgi?id=626858 diff --git a/glib/glibmm/signalproxy_connectionnode.cc b/glib/glibmm/signalproxy_connectionnode.cc index c0f64c9c..cc6f7079 100644 --- a/glib/glibmm/signalproxy_connectionnode.cc +++ b/glib/glibmm/signalproxy_connectionnode.cc @@ -52,7 +52,7 @@ void* SignalProxyConnectionNode::notify(void* data) { GObject* o = conn->object_; conn->object_ = 0; - + if(g_signal_handler_is_connected(o, conn->connection_id_)) //We check first, because during destruction, GTK+ sometimes seems to disconnect them for us, before we expect it to. See bug #87912 { // Disconnecting triggers execution of destroy_notify_handler(), eiter immediately or later: @@ -60,11 +60,11 @@ void* SignalProxyConnectionNode::notify(void* data) // In that case, destroy_notify_handler() will be called after this whole function has returned. // Anyway. destroy_notify_handler() will always be called, so we leave that to do the deletion. - + //Forget the connection: gulong connection_id = conn->connection_id_; conn->connection_id_ = 0; - + g_signal_handler_disconnect(o, connection_id); } } @@ -77,7 +77,7 @@ void SignalProxyConnectionNode::destroy_notify_handler(gpointer data, GClosure*) { //glib calls this when it has finished with a glib signal connection, //either when the emitting object dies, or when the connection has been disconnected. - + // notification from gtk+. SignalProxyConnectionNode* conn = static_cast<SignalProxyConnectionNode*>(data); diff --git a/glib/glibmm/slisthandle.h b/glib/glibmm/slisthandle.h index 67728f50..a83cc85e 100644 --- a/glib/glibmm/slisthandle.h +++ b/glib/glibmm/slisthandle.h @@ -151,10 +151,10 @@ private: //TODO: Remove this when we can break glibmm API. /** This is an intermediate type. When a method takes this, or returns this, you - * should use a standard C++ container of your choice, such as std::list or + * should use a standard C++ container of your choice, such as std::list or * std::vector. * - * However, this is not used in new API. We now prefer to just use std::vector, + * However, this is not used in new API. We now prefer to just use std::vector, * which is less flexibile, but makes the API clearer. * @ingroup ContHandles */ diff --git a/glib/glibmm/timeval.cc b/glib/glibmm/timeval.cc index f99083bb..99b65977 100644 --- a/glib/glibmm/timeval.cc +++ b/glib/glibmm/timeval.cc @@ -30,7 +30,7 @@ void TimeVal::assign_current_time() { g_get_current_time(this); } - + bool TimeVal::assign_from_iso8601(const Glib::ustring& iso_date) { return g_time_val_from_iso8601(iso_date.c_str(), this); @@ -108,7 +108,7 @@ void TimeVal::subtract_milliseconds(long milliseconds) } void TimeVal::add_microseconds(long microseconds) -{ +{ g_time_val_add(this, microseconds); } diff --git a/glib/glibmm/timeval.h b/glib/glibmm/timeval.h index 8897ee1c..0e49dba4 100644 --- a/glib/glibmm/timeval.h +++ b/glib/glibmm/timeval.h @@ -43,11 +43,11 @@ struct TimeVal : public GTimeVal inline TimeVal& operator=(const GTimeVal& gtimeval); /** Assigns the current time to the TimeVal instance. - * Equivalent to the UNIX gettimeofday() function, but is portable and - * works also on Win32. + * Equivalent to the UNIX gettimeofday() function, but is portable and + * works also on Win32. */ void assign_current_time(); - + /** Converts a string containing an ISO 8601 encoded date and time * to a Glib::TimeVal and puts it in TimeVal instance. * @param iso_date ISO 8601 encoded string. @@ -178,17 +178,17 @@ TimeVal operator+(const TimeVal& lhs, const TimeVal& rhs) { return TimeVal(lhs) += rhs; } /** @relates Glib::TimeVal */ -inline +inline TimeVal operator+(const TimeVal& lhs, long seconds) { return TimeVal(lhs) += seconds; } /** @relates Glib::TimeVal */ -inline +inline TimeVal operator-(const TimeVal& lhs, const TimeVal& rhs) { return TimeVal(lhs) -= rhs; } /** @relates Glib::TimeVal */ -inline +inline TimeVal operator-(const TimeVal& lhs, long seconds) { return TimeVal(lhs) -= seconds; } diff --git a/glib/glibmm/ustring.cc b/glib/glibmm/ustring.cc index 62b79d7d..0d31d48f 100644 --- a/glib/glibmm/ustring.cc +++ b/glib/glibmm/ustring.cc @@ -219,7 +219,7 @@ namespace Glib { #ifndef GLIBMM_HAVE_ALLOWS_STATIC_INLINE_NPOS -// Initialize static member here, +// Initialize static member here, // because the compiler did not allow us do it inline. const ustring::size_type ustring::npos = std::string::npos; #endif diff --git a/glib/glibmm/value.h b/glib/glibmm/value.h index c0890154..4873d684 100644 --- a/glib/glibmm/value.h +++ b/glib/glibmm/value.h @@ -108,7 +108,7 @@ public: protected: void set_boxed(const void* data); - void* get_boxed() const; // doesn't copy + void* get_boxed() const; // doesn't copy }; @@ -235,7 +235,7 @@ public: CppType get() const { return Glib::RefPtr<T>::cast_dynamic(get_object_copy()); } }; -//The SUN Forte Compiler has a problem with this: +//The SUN Forte Compiler has a problem with this: #ifdef GLIBMM_HAVE_DISAMBIGUOUS_CONST_TEMPLATE_SPECIALIZATIONS /** Partial specialization for RefPtr<> to const Glib::Object. diff --git a/glib/glibmm/value_custom.h b/glib/glibmm/value_custom.h index 17db8791..a63fc420 100644 --- a/glib/glibmm/value_custom.h +++ b/glib/glibmm/value_custom.h @@ -88,7 +88,7 @@ private: inline CppType get_(void*) const; }; - + /** Generic value implementation for custom types. * @ingroup glibmmValue * Any type to be used with this template must implement: diff --git a/glib/glibmm/wrap.cc b/glib/glibmm/wrap.cc index 38e75716..4d9c71cf 100644 --- a/glib/glibmm/wrap.cc +++ b/glib/glibmm/wrap.cc @@ -132,7 +132,7 @@ static gboolean gtype_wraps_interface(GType implementer_type, GType interface_ty { found = (ifaces[n_ifaces] == interface_type); } - + g_free (ifaces); return found; @@ -156,7 +156,7 @@ Glib::ObjectBase* wrap_create_new_wrapper_for_interface(GObject* object, GType i { // Look up the wrap table index stored in the type's static data. // If a wrap_new() has been registered for the type then call it. - // But only if the type implements the interface, + // But only if the type implements the interface, // so that the C++ instance is likely to inherit from the appropriate class too. // const gpointer idx = g_type_get_qdata(type, Glib::quark_); diff --git a/glib/glibmm/wrap.h b/glib/glibmm/wrap.h index a65bcf6a..5b07395b 100644 --- a/glib/glibmm/wrap.h +++ b/glib/glibmm/wrap.h @@ -73,8 +73,8 @@ TInterface* wrap_auto_interface(GObject* object, bool take_copy = false) pCppObject = wrap_create_new_wrapper_for_interface(object, TInterface::get_base_type()); } - //If no exact wrapper was created, - //create an instance of the interface, + //If no exact wrapper was created, + //create an instance of the interface, //so we at least get the expected type: TInterface* result = 0; if(pCppObject) diff --git a/glib/src/bytes.hg b/glib/src/bytes.hg index 424347af..1c81e61b 100644 --- a/glib/src/bytes.hg +++ b/glib/src/bytes.hg @@ -60,7 +60,7 @@ class Bytes public: static Glib::RefPtr<Glib::Bytes> create(gconstpointer data, gsize size); - + _WRAP_METHOD(gconstpointer get_data(gsize& size) const, g_bytes_get_data) _WRAP_METHOD(gsize get_size() const, g_bytes_get_size) diff --git a/glib/src/checksum.ccg b/glib/src/checksum.ccg index 6a0a7871..19cdc280 100644 --- a/glib/src/checksum.ccg +++ b/glib/src/checksum.ccg @@ -43,7 +43,7 @@ std::string Checksum::compute_checksum(ChecksumType type, const std::string& dat void Checksum::update(const std::string& data) { - g_checksum_update(gobj(), (const guchar*)data.c_str(), data.size()); + g_checksum_update(gobj(), (const guchar*)data.c_str(), data.size()); } } // Glib namespace diff --git a/glib/src/checksum.hg b/glib/src/checksum.hg index 934c70a4..528251ec 100644 --- a/glib/src/checksum.hg +++ b/glib/src/checksum.hg @@ -28,11 +28,11 @@ namespace Glib { /** Computes the checksum for data. - * This is a generic API for computing checksums (or "digests") for a sequence of arbitrary bytes, + * This is a generic API for computing checksums (or "digests") for a sequence of arbitrary bytes, * using various hashing algorithms like MD5, SHA-1 and SHA-256. Checksums are commonly used in various environments and specifications. * - * glibmm supports incremental checksums by calling update() as long as there's data available and then using get_string() - * or get_digest() to compute the checksum and return it either as a string in hexadecimal form, or as a raw sequence of bytes. + * glibmm supports incremental checksums by calling update() as long as there's data available and then using get_string() + * or get_digest() to compute the checksum and return it either as a string in hexadecimal form, or as a raw sequence of bytes. * To compute the checksum for binary blobs and NULL-terminated strings in one go, use the static compute_checksum() convenience functions(). * * @newin{2,16} @@ -52,8 +52,8 @@ public: * The hashing algorithm to be used by Checksum when performing the * digest of some data. * - * Note that the ChecksumType enumeration may be extended at a later - * date to include new hashing algorithm types. + * Note that the ChecksumType enumeration may be extended at a later + * date to include new hashing algorithm types. * * @newin{2,16} */ @@ -61,7 +61,7 @@ public: #m4 _CONVERSION(`ChecksumType', `GChecksumType', `(($2)$3)') - /** Creates a new Checksum, using the checksum algorithm @a checksum_type. + /** Creates a new Checksum, using the checksum algorithm @a checksum_type. * If the checksum_type is not known, then operator bool() will return false. * * @param type checksum type, one of defined above. @@ -74,14 +74,14 @@ public: operator bool() const; _WRAP_METHOD(void reset(), g_checksum_reset) - + //TODO: length should really be gssize, not gsize, when we can break ABI: #m4 _CONVERSION(`gsize',`gssize',`(gssize)($3)') _WRAP_METHOD(void update(const guchar* data, gsize length), g_checksum_update) /** Feeds data into an existing Checksum. * The checksum must still be open, that is get_string() or get_digest() must not have been called on the checksum. - * + * * @param data Buffer used to compute the checksum */ void update(const std::string& data); @@ -90,11 +90,11 @@ public: _WRAP_METHOD(std::string get_string() const, g_checksum_get_string) - + _WRAP_METHOD(static std::string compute_checksum(ChecksumType type, const guchar* data, gsize length), g_compute_checksum_for_data) /** Computes the checksum of a string. - * + * * @param checksum_type A ChecksumType * @param str The string to compute the checksum of. * @result The checksum as a hexadecimal string. diff --git a/glib/src/convert.ccg b/glib/src/convert.ccg index 33ae8287..b216f932 100644 --- a/glib/src/convert.ccg +++ b/glib/src/convert.ccg @@ -274,7 +274,7 @@ Glib::ustring filename_to_uri(const std::string& filename) Glib::ustring filename_display_basename(const std::string& filename) { char *const buf = g_filename_display_basename(filename.c_str()); - + return Glib::ustring(ScopedPtr<char>(buf).get()); } @@ -282,7 +282,7 @@ Glib::ustring filename_display_basename(const std::string& filename) Glib::ustring filename_display_name(const std::string& filename) { char *const buf = g_filename_display_name(filename.c_str()); - + return Glib::ustring(ScopedPtr<char>(buf).get()); } diff --git a/glib/src/convert.hg b/glib/src/convert.hg index 194b5d94..de5e12ab 100644 --- a/glib/src/convert.hg +++ b/glib/src/convert.hg @@ -247,11 +247,11 @@ Glib::ustring filename_to_uri(const std::string& filename); */ Glib::ustring filename_display_basename(const std::string& filename); -/** Converts a filename into a valid UTF-8 string. The - * conversion is not necessarily reversible, so you +/** Converts a filename into a valid UTF-8 string. The + * conversion is not necessarily reversible, so you * should keep the original around and use the return * value of this function only for display purposes. - * Unlike g_filename_to_utf8(), the result is guaranteed + * Unlike g_filename_to_utf8(), the result is guaranteed * to be non-empty even if the filename actually isn't in the GLib * file name encoding. * diff --git a/glib/src/iochannel.hg b/glib/src/iochannel.hg index f04a14b9..2c89419a 100644 --- a/glib/src/iochannel.hg +++ b/glib/src/iochannel.hg @@ -428,7 +428,7 @@ protected: /** Constructor that should be used by derived classes. * Use this constructor if you want to inherit from IOChannel. - * It will set up a GIOChannel that will call the vfuncs of your + * It will set up a GIOChannel that will call the vfuncs of your * class even if it is being used from C code, and it will keep * a reference to the C++ code while the GIOChannel exists. */ diff --git a/glib/src/keyfile.ccg b/glib/src/keyfile.ccg index 5a6c65e5..366b4980 100644 --- a/glib/src/keyfile.ccg +++ b/glib/src/keyfile.ccg @@ -155,7 +155,7 @@ bool KeyFile::get_boolean(const Glib::ustring& key) const { GError* gerror = 0; const bool value = - static_cast<bool>(g_key_file_get_boolean(const_cast<GKeyFile*>(gobj()), + static_cast<bool>(g_key_file_get_boolean(const_cast<GKeyFile*>(gobj()), 0, key.c_str(), &gerror)); if(gerror) Glib::Error::throw_exception(gerror); @@ -213,7 +213,7 @@ double KeyFile::get_double(const Glib::ustring& key) const void KeyFile::set_double(const Glib::ustring& key, double value) { - g_key_file_set_double(gobj(), 0, key.c_str(), value); + g_key_file_set_double(gobj(), 0, key.c_str(), value); } # define GLIBMM_ERROR_ARG diff --git a/glib/src/keyfile.hg b/glib/src/keyfile.hg index 415dd496..db176396 100644 --- a/glib/src/keyfile.hg +++ b/glib/src/keyfile.hg @@ -37,12 +37,12 @@ namespace Glib */ _WRAP_GERROR(KeyFileError, GKeyFileError, G_KEY_FILE_ERROR, NO_GTYPE) -/** This class lets you parse, edit or create files containing groups of key-value pairs, which we call key files - * for lack of a better name. Several freedesktop.org specifications use key files now, e.g the Desktop Entry +/** This class lets you parse, edit or create files containing groups of key-value pairs, which we call key files + * for lack of a better name. Several freedesktop.org specifications use key files now, e.g the Desktop Entry * Specification and the Icon Theme Specification. * - * The syntax of key files is described in detail in the Desktop Entry Specification, here is a quick summary: Key - * files consists of groups of key-value pairs, interspersed with comments. + * The syntax of key files is described in detail in the Desktop Entry Specification, here is a quick summary: Key + * files consists of groups of key-value pairs, interspersed with comments. * * @code * # this is just an example @@ -67,28 +67,28 @@ _WRAP_GERROR(KeyFileError, GKeyFileError, G_KEY_FILE_ERROR, NO_GTYPE) * * Lines beginning with a '#' and blank lines are considered comments. * - * Groups are started by a header line containing the group name enclosed in '[' and ']', and ended implicitly by + * Groups are started by a header line containing the group name enclosed in '[' and ']', and ended implicitly by * the start of the next group or the end of the file. Each key-value pair must be contained in a group. - * - * Key-value pairs generally have the form key=value, with the exception of localized strings, which have the form - * key[locale]=value. Space before and after the '=' character are ignored. Newline, tab, carriage return and - * backslash characters in value are escaped as \\n, \\t, \\r, and \\\\, respectively. To preserve leading spaces in + * + * Key-value pairs generally have the form key=value, with the exception of localized strings, which have the form + * key[locale]=value. Space before and after the '=' character are ignored. Newline, tab, carriage return and + * backslash characters in value are escaped as \\n, \\t, \\r, and \\\\, respectively. To preserve leading spaces in * values, these can also be escaped as \\s. - * - * Key files can store strings (possibly with localized variants), integers, booleans and lists of these. Lists are - * separated by a separator character, typically ';' or ','. To use the list separator character in a value in a + * + * Key files can store strings (possibly with localized variants), integers, booleans and lists of these. Lists are + * separated by a separator character, typically ';' or ','. To use the list separator character in a value in a * list, it has to be escaped by prefixing it with a backslash. - * - * This syntax is obviously inspired by the .ini files commonly met on Windows, but there are some important + * + * This syntax is obviously inspired by the .ini files commonly met on Windows, but there are some important * differences: * - .ini files use the ';' character to begin comments, key files use the '#' character. * - Key files allow only comments before the first group. * - Key files are always encoded in UTF-8. * - Key and Group names are case-sensitive, for example a group called [GROUP] is a different group from [group]. - * - * Note that in contrast to the Desktop Entry Specification, groups in key files may contain the same key multiple - * times; the last entry wins. Key files may also contain multiple groups with the same name; they are merged - * together. Another difference is that keys and group names in key files are not restricted to ASCII characters. + * + * Note that in contrast to the Desktop Entry Specification, groups in key files may contain the same key multiple + * times; the last entry wins. Key files may also contain multiple groups with the same name; they are merged + * together. Another difference is that keys and group names in key files are not restricted to ASCII characters. * * @newin{2,14} */ @@ -112,7 +112,7 @@ public: _IGNORE(g_key_file_free) /** Creates a glibmm KeyFile wrapper for a GKeyFile object. - * Note, when using this that when the wrapper is deleted, + * Note, when using this that when the wrapper is deleted, * it will not automatically deleted the GKeyFile unless you * set the delete_c_instance boolean to true. * @param castitem The C instance to wrap @@ -262,7 +262,7 @@ _DEPRECATE_IFDEF_END /** Associates a new double value with @a key under the start group. * If @a key cannot be found then it is created. - * + * * @newin{2,12} * @param key A key. * @param value An double value. @@ -349,7 +349,7 @@ _DEPRECATE_IFDEF_END _WRAP_METHOD(void set_int64(const Glib::ustring& group_name, const Glib::ustring& key, gint64 value), g_key_file_set_int64) _WRAP_METHOD(void set_uint64(const Glib::ustring& group_name, const Glib::ustring& key, guint64 value), g_key_file_set_uint64) - /** Sets a list of string values for @a key under @a group_name. If + /** Sets a list of string values for @a key under @a group_name. If * key cannot be found it is created. If @a group_name cannot be found * it is created. * @param group_name The name of a group diff --git a/glib/src/markup.ccg b/glib/src/markup.ccg index 3d52d81e..ae3d4d2f 100644 --- a/glib/src/markup.ccg +++ b/glib/src/markup.ccg @@ -63,13 +63,13 @@ public: static void text(GMarkupParseContext* context, const char* text, - gsize text_len, + gsize text_len, void* user_data, GError** error); static void passthrough(GMarkupParseContext* context, const char* passthrough_text, - gsize text_len, + gsize text_len, void* user_data, GError** error); @@ -149,7 +149,7 @@ void ParserCallbacks::end_element(GMarkupParseContext* context, void ParserCallbacks::text(GMarkupParseContext* context, const char* text, - gsize text_len, + gsize text_len, void* user_data, GError** error) { @@ -172,7 +172,7 @@ void ParserCallbacks::text(GMarkupParseContext* context, void ParserCallbacks::passthrough(GMarkupParseContext* context, const char* passthrough_text, - gsize text_len, + gsize text_len, void* user_data, GError** error) { diff --git a/glib/src/module.hg b/glib/src/module.hg index a1bdb7e5..afa2bcd9 100644 --- a/glib/src/module.hg +++ b/glib/src/module.hg @@ -44,7 +44,7 @@ class Module _IGNORE(g_module_open, g_module_close) public: - + /** Opens a module. * * First of all it tries to open file_name as a module. If that diff --git a/glib/src/nodetree.hg b/glib/src/nodetree.hg index c8f89fb0..ad99555b 100644 --- a/glib/src/nodetree.hg +++ b/glib/src/nodetree.hg @@ -30,11 +30,11 @@ _DEFS(glibmm,glib) namespace Glib { -//Hand-written, instead of using _WRAP_ENUM, +//Hand-written, instead of using _WRAP_ENUM, //because the C enum values don't have a prefix. /** Specifies the type of traveral performed by methods such as NodeTree::_traverse() and NodeTree::find(). - * + * * @ingroup glibmmEnums */ enum TraverseType @@ -47,24 +47,24 @@ enum TraverseType /** N-ary Trees - trees of data with any number of branches * The NodeTree class and its associated functions provide an N-ary tree data structure, in which nodes in the tree can contain arbitrary data. - * + * * To insert a node into a tree use insert(), insert_before(), append() or prepend(). - * + * * To create a new node and insert it into a tree use insert_data(), insert_data_before(), append_data() and prepend_data(). - * + * * To reverse the children of a node use reverse_children(). - * + * * To find a node use root(), find(), find_child(), index_of(), child_index(), first_child(), last_child(), nth_child(), first_sibling(), prev_sibling(), next_sibling() or last_sibling(). - * + * * To get information about a node or tree use is_leaf(), is_root(), depth(), node_count(), child_count(), is_ancestor() or max_height(). - * + * * To traverse a tree, calling a function for each node visited in the traversal, use traverse() or foreach(). - * + * * To remove a node or subtree from a tree use unlink(). * * @newin{2,18} */ -template <typename T> +template <typename T> class NodeTree { _CLASS_GENERIC(NodeTree, GNode) @@ -136,7 +136,7 @@ public: /** Inserts a NodeTree beneath the parent at the given position. * - * @param position the position to place node at, with respect to its siblings + * @param position the position to place node at, with respect to its siblings * If position is -1, node is inserted as the last child of parent * @param node the NodeTree to insert * @return the inserted NodeTree @@ -201,7 +201,7 @@ public: /** Inserts a new NodeTree at the given position. * - * @param position the position to place the new NodeTree at. + * @param position the position to place the new NodeTree at. * If position is -1, the new NodeTree is inserted as the last child of parent * @param data the data for the new NodeTree * @return the new NodeTree @@ -216,7 +216,7 @@ public: /** Inserts a new NodeTree before the given sibling. * - * @param sibling the sibling NodeTree to place node before. + * @param sibling the sibling NodeTree to place node before. * @param data the data for the new NodeTree * @return the new NodeTree */ @@ -292,13 +292,13 @@ public: }; /** Traverses a tree starting at the current node. - * It calls the given function for each node visited. + * It calls the given function for each node visited. * The traversal can be halted at any point by returning true from @a func. * * @param order The order in which nodes are visited. * @param flags Which types of children are to be visited. - * @param max_depth The maximum depth of the traversal. - * Nodes below this depth will not be visited. + * @param max_depth The maximum depth of the traversal. + * Nodes below this depth will not be visited. * If max_depth is -1 all nodes in the tree are visited. * If max_depth is 1, only the root is visited. * If max_depth is 2, the root and its children are visited. And so on. @@ -339,7 +339,7 @@ public: type_foreach_gnode_slot bound_slot = sigc::bind(real_slot, the_data, &child); g_node_children_foreach(gobj(), (GTraverseFlags)flags, c_callback_foreach_compare_child, reinterpret_cast<gpointer>(&bound_slot)); - + return wrap(child); } @@ -411,7 +411,7 @@ public: } _IGNORE(g_node_child_index) - /** Gets the position with respect to its siblings. + /** Gets the position with respect to its siblings. * child must be a child of node. * The first child is numbered 0, the second 1, and so on. * @@ -426,7 +426,7 @@ public: /** Gets the first child. * - * @return The first child, or 0 if the node has no children. + * @return The first child, or 0 if the node has no children. */ NodeTree<T>* first_child() { @@ -435,7 +435,7 @@ public: /** Gets the first child. * - * @return The first child, or 0 if the node has no children. + * @return The first child, or 0 if the node has no children. */ const NodeTree<T>* first_child() const { @@ -466,7 +466,7 @@ public: * * @return The nth child, or 0 if n is too large. */ - NodeTree<T>* nth_child(int n) + NodeTree<T>* nth_child(int n) { return wrap(g_node_nth_child(gobj(), n)); } @@ -480,7 +480,7 @@ public: return const_cast<NodeTree<T>*>(this)->nth_child(n); } _IGNORE(g_node_nth_child) - + /** Gets the first sibling * @return The first sibling, or 0 if the node has no siblings. */ diff --git a/glib/src/optioncontext.ccg b/glib/src/optioncontext.ccg index fec4329d..601b928c 100644 --- a/glib/src/optioncontext.ccg +++ b/glib/src/optioncontext.ccg @@ -64,7 +64,7 @@ OptionContext::~OptionContext() { if(has_ownership_) g_option_context_free(gobj()); - + gobject_ = 0; } diff --git a/glib/src/optioncontext.hg b/glib/src/optioncontext.hg index 770d8899..bc31f15d 100644 --- a/glib/src/optioncontext.hg +++ b/glib/src/optioncontext.hg @@ -46,12 +46,12 @@ public: * @param parameter_string A string which is displayed in the first line of --help output, after programname [OPTION...] */ explicit OptionContext(const Glib::ustring& parameter_string = Glib::ustring()); - + //Note that, unlike Glib::Wrap(), this would create a second C++ instance for the same C instance, //so it should be used carefully. For instance you could not access data in a derived class via this second instance. explicit OptionContext(GOptionContext* castitem, bool take_ownership = false); virtual ~OptionContext(); - + _WRAP_METHOD(void set_help_enabled(bool help_enabled = true), g_option_context_set_help_enabled) _WRAP_METHOD(bool get_help_enabled() const, g_option_context_get_help_enabled) _WRAP_METHOD(void set_ignore_unknown_options(bool ignore_unknown = true), g_option_context_set_ignore_unknown_options) @@ -63,16 +63,16 @@ public: //g_option_context_add_main_entries(), just creates a group internally, adds them to it, and does a set_main_group() //- a group without callbacks seems to do some simple default parsing. _IGNORE(g_option_context_add_main_entries) - - /** Adds an OptionGroup to the context, so that parsing with context will recognize the options in the group. + + /** Adds an OptionGroup to the context, so that parsing with context will recognize the options in the group. * Note that the group will not be copied, so it should exist for as long as the context exists. * * @param group The group to add. */ void add_group(OptionGroup& group); _IGNORE(g_option_context_add_group) - - /** Sets an OptionGroup as the main group of the context. This has the same effect as calling add_group(), the only + + /** Sets an OptionGroup as the main group of the context. This has the same effect as calling add_group(), the only * difference is that the options in the main group are treated differently when generating --help output. * Note that the group will not be copied, so it should exist for as long as the context exists. * @@ -80,7 +80,7 @@ public: */ void set_main_group(OptionGroup& group); _IGNORE(g_option_context_set_main_group) - + //We don't need this (hopefully), and the memory management would be really awkward. //OptionGroup& get_main_group(); //const OptionGroup& get_main_group() const; @@ -88,9 +88,9 @@ public: #m4 _CONVERSION(`const OptionGroup&',`GOptionGroup*',`const_cast<GOptionGroup*>(($3).gobj())') _WRAP_METHOD(Glib::ustring get_help(bool main_help, const OptionGroup& group) const, g_option_context_get_help) - - /** Returns a formatted, translated help text for the given context. - * To obtain the text produced by --help, call get_help (true). + + /** Returns a formatted, translated help text for the given context. + * To obtain the text produced by --help, call get_help (true). * To obtain the text produced by --help-all, call get_help(false). * To obtain the help text for an option group, call get_help(false, group). * diff --git a/glib/src/optionentry.ccg b/glib/src/optionentry.ccg index 2febf45c..9a64f102 100644 --- a/glib/src/optionentry.ccg +++ b/glib/src/optionentry.ccg @@ -28,10 +28,10 @@ OptionEntry::OptionEntry() OptionEntry::~OptionEntry() { - g_free(const_cast<char*>(gobject_->long_name)); + g_free(const_cast<char*>(gobject_->long_name)); g_free(const_cast<char*>(gobject_->description)); g_free(const_cast<char*>(gobject_->arg_description)); - g_free(gobject_); + g_free(gobject_); } OptionEntry::OptionEntry(const OptionEntry& src) @@ -57,7 +57,7 @@ OptionEntry& OptionEntry::operator=(const OptionEntry& src) gobject_->arg_data = src.gobject_->arg_data; //Shared, because it's not owned by any instance of this class anyway. if(gobject_->description) - g_free(const_cast<char*>(gobject_->description)); + g_free(const_cast<char*>(gobject_->description)); gobject_->description = g_strdup(src.gobject_->description); @@ -78,9 +78,9 @@ void OptionEntry::set_long_name(const Glib::ustring& value) gobject_->long_name = 0; } - //Note that we do not use NULL for an empty string, + //Note that we do not use NULL for an empty string, //because G_OPTION_REMAINING is actually a "", so it actually has a distinct meaning: - //TODO: Wrap G_OPTION_REMAINING in C++ somehow, maybe as an explicit set_long_name(void) or set_is_remaining()? murrayc. + //TODO: Wrap G_OPTION_REMAINING in C++ somehow, maybe as an explicit set_long_name(void) or set_is_remaining()? murrayc. gobj()->long_name = (value).c_str() ? g_strdup((value).c_str()) : 0; } @@ -105,7 +105,7 @@ void OptionEntry::set_arg_description(const Glib::ustring& value) gobj()->arg_description = (value).empty() ? 0 : g_strdup((value).c_str()); } - + } // namespace Glib diff --git a/glib/src/optionentry.hg b/glib/src/optionentry.hg index 70b8d658..852dff20 100644 --- a/glib/src/optionentry.hg +++ b/glib/src/optionentry.hg @@ -27,18 +27,18 @@ extern "C" { typedef struct _GOptionEntry GOptionEntry; } namespace Glib { -/** An OptionEntry defines a single option. To have an effect, it must be added to an OptionGroup with +/** An OptionEntry defines a single option. To have an effect, it must be added to an OptionGroup with * OptionGroup::add_entry(). - * - * The long name of an option can be used to specify it in a commandline as --long_name. - * Every option must have a long name. To resolve conflicts if multiple option groups contain the same long name, it is also + * + * The long name of an option can be used to specify it in a commandline as --long_name. + * Every option must have a long name. To resolve conflicts if multiple option groups contain the same long name, it is also * possible to specify the option as --groupname-long_name. * * If an option has a short name, it can be specified as -short_name in a commandline. * * The description for the option is shown in the --help output. * - * The arg_descripton is the placeholder to use for the extra argument parsed by the option in --help output. + * The arg_descripton is the placeholder to use for the extra argument parsed by the option in --help output. */ class OptionEntry { @@ -60,36 +60,36 @@ public: OptionEntry(); OptionEntry(const OptionEntry& src); virtual ~OptionEntry(); - + OptionEntry& operator=(const OptionEntry& src); //#m4 _CONVERSION(`Glib::ustring',`const gchar*',`($3).empty() ? NULL : g_strdup(($3).c_str())') - + _MEMBER_GET(long_name, long_name, Glib::ustring, const char*) void set_long_name(const Glib::ustring& value); - + _MEMBER_GET(short_name, short_name, gchar, gchar) _MEMBER_SET(short_name, short_name, gchar, gchar) - + _MEMBER_GET(flags, flags, int, int) /** Set one or more OptionEntry::Flags. * Do not set FLAG_FILENAME. Character encoding is chosen when the OptionEntry * is added to an OptionGroup. */ _MEMBER_SET(flags, flags, int, int) - + _MEMBER_GET(description, description, Glib::ustring, const char*) void set_description(const Glib::ustring& value); - + _MEMBER_GET(arg_description, arg_description, Glib::ustring, const char*) void set_arg_description(const Glib::ustring& value); - + GOptionEntry* gobj() { return gobject_; } const GOptionEntry* gobj() const { return gobject_; } - + protected: GOptionEntry* gobject_; diff --git a/glib/src/optiongroup.ccg b/glib/src/optiongroup.ccg index 1d6697ae..baa1331c 100644 --- a/glib/src/optiongroup.ccg +++ b/glib/src/optiongroup.ccg @@ -43,10 +43,10 @@ public: bool is_filename_option() const { return slot_filename_ != 0; } - + const OptionGroup::SlotOptionArgString* get_slot_string() const { return slot_string_; } - + const OptionGroup::SlotOptionArgFilename* get_slot_filename() const { return slot_filename_; } @@ -743,8 +743,8 @@ void OptionGroup::CppOptionEntry::convert_c_to_cpp() //Glib::StringArrayHandle array_handle(*typed_arg, Glib::OWNERSHIP_NONE); //The SUN Forte compiler complains about this: - // "optiongroup.cc", line 354: Error: Cannot assign Glib::ArrayHandle<Glib::ustring, - // Glib::Container_Helpers::TypeTraits<Glib::ustring>> to std::vector<Glib::ustring> without + // "optiongroup.cc", line 354: Error: Cannot assign Glib::ArrayHandle<Glib::ustring, + // Glib::Container_Helpers::TypeTraits<Glib::ustring>> to std::vector<Glib::ustring> without // "std::vector<Glib::ustring>::operator=(const std::vector<Glib::ustring>&)";. // //(*typed_cpp_arg) = array_handle; @@ -777,7 +777,7 @@ void OptionGroup::CppOptionEntry::convert_c_to_cpp() char*** typed_arg = static_cast<char***>(carg_); vecustrings* typed_cpp_arg = static_cast<vecustrings*>(cpparg_); if(typed_arg && typed_cpp_arg) - { + { typed_cpp_arg->clear(); //See comments above about the SUN Forte and Tru64 compilers. @@ -808,7 +808,7 @@ void OptionGroup::CppOptionEntry::convert_c_to_cpp() break; } } -} +} GOptionGroup* OptionGroup::gobj_give_ownership() { diff --git a/glib/src/optiongroup.hg b/glib/src/optiongroup.hg index 59fd1171..7d330eb6 100644 --- a/glib/src/optiongroup.hg +++ b/glib/src/optiongroup.hg @@ -37,7 +37,7 @@ class OptionEntry; class OptionContext; #endif //DOXYGEN_SHOULD_SKIP_THIS -/** An OptionGroup defines the options in a single group. +/** An OptionGroup defines the options in a single group. * Libraries which need to parse commandline options are expected to provide a function that allows their OptionGroups to * be added to the application's OptionContext. */ @@ -53,7 +53,7 @@ public: * const Glib::ustring& value, bool has_value);. */ typedef sigc::slot<bool, const Glib::ustring&, const Glib::ustring&, bool> SlotOptionArgString; - + /** For example bool on_option_arg_filename(const Glib::ustring& option_name, * const std::string& value, bool has_value);. */ @@ -61,10 +61,10 @@ public: OptionGroup(const Glib::ustring& name, const Glib::ustring& description, const Glib::ustring& help_description = Glib::ustring()); - /** This always takes ownership of the underlying GOptionGroup, - * so it is only useful with C functions that return newly-allocated GOptionGroups. + /** This always takes ownership of the underlying GOptionGroup, + * so it is only useful with C functions that return newly-allocated GOptionGroups. */ - explicit OptionGroup(GOptionGroup* castitem); + explicit OptionGroup(GOptionGroup* castitem); _IGNORE(g_option_group_new) virtual ~OptionGroup(); @@ -87,7 +87,7 @@ public: void add_entry(const OptionEntry& entry, int& arg); void add_entry(const OptionEntry& entry, double& arg); void add_entry(const OptionEntry& entry, Glib::ustring& arg); - void add_entry_filename(const OptionEntry& entry, std::string& arg); + void add_entry_filename(const OptionEntry& entry, std::string& arg); void add_entry(const OptionEntry& entry, vecustrings& arg); void add_entry_filename(const OptionEntry& entry, vecstrings& arg); void add_entry(const OptionEntry& entry, const SlotOptionArgString& slot); diff --git a/glib/src/regex.hg b/glib/src/regex.hg index 63f0dff1..33b1701b 100644 --- a/glib/src/regex.hg +++ b/glib/src/regex.hg @@ -43,53 +43,53 @@ class MatchInfo; /** Perl-compatible regular expressions - matches strings against regular expressions. * - * The Glib::Regex functions implement regular expression pattern matching using + * The Glib::Regex functions implement regular expression pattern matching using * syntax and semantics similar to Perl regular expression. * - * Some functions accept a start_position argument, setting it differs from just - * passing over a shortened string and setting REGEX_MATCH_NOTBOL in the case - * of a pattern that begins with any kind of lookbehind assertion. For example, - * consider the pattern "\Biss\B" which finds occurrences of "iss" in the middle - * of words. ("\B" matches only if the current position in the subject is not a - * word boundary.) When applied to the string "Mississipi" from the fourth byte, - * namely "issipi", it does not match, because "\B" is always false at the - * start of the subject, which is deemed to be a word boundary. However, if - * the entire string is passed , but with start_position set to 4, it finds the + * Some functions accept a start_position argument, setting it differs from just + * passing over a shortened string and setting REGEX_MATCH_NOTBOL in the case + * of a pattern that begins with any kind of lookbehind assertion. For example, + * consider the pattern "\Biss\B" which finds occurrences of "iss" in the middle + * of words. ("\B" matches only if the current position in the subject is not a + * word boundary.) When applied to the string "Mississipi" from the fourth byte, + * namely "issipi", it does not match, because "\B" is always false at the + * start of the subject, which is deemed to be a word boundary. However, if + * the entire string is passed , but with start_position set to 4, it finds the * second occurrence of "iss" because it is able to look behind the starting point * to discover that it is preceded by a letter. * - * Note that, unless you set the REGEX_RAW flag, all the strings passed to these + * Note that, unless you set the REGEX_RAW flag, all the strings passed to these * functions must be encoded in UTF-8. The lengths and the positions inside the - * strings are in bytes and not in characters, so, for instance, - * "\xc3\xa0" (i.e. "à") is two bytes long but it is treated as a single + * strings are in bytes and not in characters, so, for instance, + * "\xc3\xa0" (i.e. "à") is two bytes long but it is treated as a single * character. If you set REGEX_RAW the strings can be non-valid UTF-8 strings - * and a byte is treated as a character, so "\xc3\xa0" is two bytes and + * and a byte is treated as a character, so "\xc3\xa0" is two bytes and * two characters long. * - * When matching a pattern, "\n" matches only against a "\n" character in the - * string, and "\r" matches only a "\r" character. To match any newline sequence - * use "\R". This particular group matches either the two-character sequence + * When matching a pattern, "\n" matches only against a "\n" character in the + * string, and "\r" matches only a "\r" character. To match any newline sequence + * use "\R". This particular group matches either the two-character sequence * CR + LF ("\r\n"), or one of the single characters LF (linefeed, U+000A, "\n"), - * VT (vertical tab, U+000B, "\v"), FF (formfeed, U+000C, "\f"), CR (carriage - * return, U+000D, "\r"), NEL (next line, U+0085), LS (line separator, U+2028), + * VT (vertical tab, U+000B, "\v"), FF (formfeed, U+000C, "\f"), CR (carriage + * return, U+000D, "\r"), NEL (next line, U+0085), LS (line separator, U+2028), * or PS (paragraph separator, U+2029). * - * The behaviour of the dot, circumflex, and dollar metacharacters are affected + * The behaviour of the dot, circumflex, and dollar metacharacters are affected * by newline characters, the default is to recognize any newline character (the * same characters recognized by "\R"). This can be changed with REGEX_NEWLINE_CR, - * REGEX_NEWLINE_LF and REGEX_NEWLINE_CRLF compile options, and with - * REGEX_MATCH_NEWLINE_ANY, REGEX_MATCH_NEWLINE_CR, REGEX_MATCH_NEWLINE_LF - * and REGEX_MATCH_NEWLINE_CRLF match options. These settings are also + * REGEX_NEWLINE_LF and REGEX_NEWLINE_CRLF compile options, and with + * REGEX_MATCH_NEWLINE_ANY, REGEX_MATCH_NEWLINE_CR, REGEX_MATCH_NEWLINE_LF + * and REGEX_MATCH_NEWLINE_CRLF match options. These settings are also * relevant when compiling a pattern if REGEX_EXTENDED is set, and an unescaped - * "#" outside a character class is encountered. This indicates a comment that + * "#" outside a character class is encountered. This indicates a comment that * lasts until after the next newline. * - * Creating and manipulating the same Glib::Regex class from different threads is - * not a problem as Glib::Regex does not modify its internal state between creation and + * Creating and manipulating the same Glib::Regex class from different threads is + * not a problem as Glib::Regex does not modify its internal state between creation and * destruction, on the other hand Glib::MatchInfo is not threadsafe. * - * The regular expressions low level functionalities are obtained through the - * excellent PCRE library written by Philip Hazel. + * The regular expressions low level functionalities are obtained through the + * excellent PCRE library written by Philip Hazel. * * @newin{2,14} */ @@ -100,12 +100,12 @@ class Regex public: static Glib::RefPtr<Glib::Regex> create(const Glib::ustring& pattern, RegexCompileFlags compile_options = static_cast<RegexCompileFlags>(0), RegexMatchFlags match_options = static_cast<RegexMatchFlags>(0)); - + _WRAP_METHOD(Glib::ustring get_pattern() const, g_regex_get_pattern) _WRAP_METHOD(int get_max_backref() const, g_regex_get_max_backref) _WRAP_METHOD(int get_capture_count() const, g_regex_get_capture_count) _WRAP_METHOD(bool get_has_cr_or_lf() const, g_regex_get_has_cr_or_lf) - + _WRAP_METHOD(int get_string_number(const Glib::ustring& name) const, g_regex_get_string_number) _WRAP_METHOD(RegexCompileFlags get_compile_flags() const, g_regex_get_compile_flags) _WRAP_METHOD(RegexMatchFlags get_match_flags() const, g_regex_get_match_flags) diff --git a/glib/src/spawn.hg b/glib/src/spawn.hg index d1778339..889a38d8 100644 --- a/glib/src/spawn.hg +++ b/glib/src/spawn.hg @@ -44,7 +44,7 @@ _WRAP_GERROR(SpawnError, GSpawnError, G_SPAWN_ERROR, NO_GTYPE, s#^2BIG$#TOOBIG#) * specified by the only argument that must be provided, @a argv. * The first string in @a argv is of * course the name of the program to execute. By default, the name of - * the program must be a full path; the PATH shell variable + * the program must be a full path; the PATH shell variable * will only be searched if you pass the SPAWN_SEARCH_PATH flag. * * On Windows, note that all the string or string vector arguments to @@ -87,25 +87,25 @@ _WRAP_GERROR(SpawnError, GSpawnError, G_SPAWN_ERROR, NO_GTYPE, s#^2BIG$#TOOBIG#) * the child's environment. * * @a flags should be the bitwise OR of any flags you want to affect the - * function's behaviour. The SPAWN_DO_NOT_REAP_CHILD flags means that + * function's behaviour. The SPAWN_DO_NOT_REAP_CHILD flags means that * the child will not automatically be reaped; you must use a - * ChildWatch source to be notified about the death of the child + * ChildWatch source to be notified about the death of the child * process. Eventually you must call spawn_close_pid() on the * @a child_pid, in order to free resources which may be associated * with the child process. (On Unix, using a ChildWatch source is - * equivalent to calling waitpid() or handling the SIGCHLD signal + * equivalent to calling waitpid() or handling the SIGCHLD signal * manually. On Windows, calling spawn_close_pid() is equivalent - * to calling CloseHandle() on the process handle returned in + * to calling CloseHandle() on the process handle returned in * @a child_pid). * * PAWN_LEAVE_DESCRIPTORS_OPEN means that the parent's open file * descriptors will be inherited by the child; otherwise all * descriptors except stdin/stdout/stderr will be closed before - * calling exec() in the child. SPAWN_SEARCH_PATH + * calling exec() in the child. SPAWN_SEARCH_PATH * means that argv[0] need not be an absolute path, it - * will be looked for in the user's PATH. - * SPAWN_STDOUT_TO_DEV_NULL means that the child's standard output will - * be discarded, instead of going to the same location as the parent's + * will be looked for in the user's PATH. + * SPAWN_STDOUT_TO_DEV_NULL means that the child's standard output will + * be discarded, instead of going to the same location as the parent's * standard output. If you use this flag, @a standard_output must be NULL. * SPAWN_STDERR_TO_DEV_NULL means that the child's standard error * will be discarded, instead of going to the same location as the parent's @@ -141,7 +141,7 @@ _WRAP_GERROR(SpawnError, GSpawnError, G_SPAWN_ERROR, NO_GTYPE, s#^2BIG$#TOOBIG#) * SPAWN_DO_NOT_REAP_CHILD flag. You can then access the child * process using the Win32 API, for example wait for its termination * with the WaitFor*() functions, or examine its - * exit code with GetExitCodeProcess(). You should close the handle + * exit code with GetExitCodeProcess(). You should close the handle * with CloseHandle() or spawn_close_pid() when you no longer need it. * * If non-NULL, the @a standard_input, @a standard_output, @a standard_error @@ -151,24 +151,24 @@ _WRAP_GERROR(SpawnError, GSpawnError, G_SPAWN_ERROR, NO_GTYPE, s#^2BIG$#TOOBIG#) * when they are no longer in use. If these parameters are NULL, the corresponding * pipe won't be created. * - * If @a standard_input is NULL, the child's standard input is attached to + * If @a standard_input is NULL, the child's standard input is attached to * /dev/null unless SPAWN_CHILD_INHERITS_STDIN is set. * - * If @a standard_error is NULL, the child's standard error goes to the same - * location as the parent's standard error unless SPAWN_STDERR_TO_DEV_NULL + * If @a standard_error is NULL, the child's standard error goes to the same + * location as the parent's standard error unless SPAWN_STDERR_TO_DEV_NULL * is set. * - * If @a standard_output is NULL, the child's standard output goes to the same - * location as the parent's standard output unless SPAWN_STDOUT_TO_DEV_NULL + * If @a standard_output is NULL, the child's standard output goes to the same + * location as the parent's standard output unless SPAWN_STDOUT_TO_DEV_NULL * is set. * * If @a child_pid is not NULL and an error does not occur then the returned * pid must be closed using spawn_close_pid(). * * @note - * If you are writing a gtkmm application, and the program you + * If you are writing a gtkmm application, and the program you * are spawning is a graphical application, too, then you may - * want to use spawn_on_screen_with_pipes() instead to ensure that + * want to use spawn_on_screen_with_pipes() instead to ensure that * the spawned program opens its windows on the right screen. * * @param working_directory Child's current working directory, or an empty string to inherit the parent's, in the GLib file name encoding. @@ -225,11 +225,11 @@ void spawn_async_with_pipes(const std::string& working_directory, /** See pawn_async_with_pipes() for a full description. This function * simply calls the spawn_async_with_pipes() without any pipes. - * + * * @note - * If you are writing a GTK+ application, and the program you + * If you are writing a GTK+ application, and the program you * are spawning is a graphical application, too, then you may - * want to use gdk_spawn_on_screen() instead to ensure that + * want to use gdk_spawn_on_screen() instead to ensure that * the spawned program opens its windows on the right screen. * * @param working_directory Child's current working directory, or an empty string to inherit parent's. @@ -273,21 +273,21 @@ void spawn_async(const std::string& working_directory, /** Executes a child synchronously (waits for the child to exit before returning). * All output from the child is stored in @a standard_output and @a standard_error, - * if those parameters are non-NULL. Note that you must set the + * if those parameters are non-NULL. Note that you must set the * SPAWN_STDOUT_TO_DEV_NULL and SPAWN_STDERR_TO_DEV_NULL flags when * passing NULL for @a standard_output and @a standard_error. * If @a exit_status is non-NULL, the exit status of the child is stored - * there as it would be returned by waitpid(); standard UNIX macros such + * there as it would be returned by waitpid(); standard UNIX macros such * as WIFEXITED() and WEXITSTATUS() must be used to evaluate the exit status. * Note that this function calls waitpid() even if @a exit_status is NULL, and * does not accept the SPAWN_DO_NOT_REAP_CHILD flag. - * If an error occurs, no data is returned in @a standard_output, - * @a standard_error, or @a exit_status. + * If an error occurs, no data is returned in @a standard_output, + * @a standard_error, or @a exit_status. * * This function calls spawn_async_with_pipes() internally; see that * function for full details on the other parameters and details on * how these functions work on Windows. - * + * * @param working_directory Child's current working directory, or an empty string to inherit the parent's, in the GLib file name encoding. * @param argv Child's argument vector. * @param envp Child's environment. @@ -313,7 +313,7 @@ void spawn_sync(const std::string& working_directory, int* exit_status = 0); /** Like the main spawn_sync() method, but inheriting the parent's environment. - * + * * @param working_directory Child's current working directory, or an empty string to inherit the parent's, in the GLib file name encoding. * @param argv Child's argument vector. * @param flags Flags from SpawnFlags @@ -341,8 +341,8 @@ void spawn_sync(const std::string& working_directory, * command line in the background. Unlike spawn_async(), the * SPAWN_SEARCH_PATH flag is enabled, other flags are not. Note * that SPAWN_SEARCH_PATH can have security implications, so - * consider using spawn_async() directly if appropriate. - * + * consider using spawn_async() directly if appropriate. + * * The same concerns on Windows apply as for spawn_command_line_sync(). * * @param command_line A command line. @@ -366,9 +366,9 @@ void spawn_command_line_async(const std::string& command_line); * If @a exit_status is non-NULL, the exit status of the child is stored there as * it would be returned by waitpid(); standard UNIX macros such as WIFEXITED() * and WEXITSTATUS() must be used to evaluate the exit status. - * + * * On Windows, please note the implications of shell_parse_argv() - * parsing @a command_line. Parsing is done according to Unix shell rules, not + * parsing @a command_line. Parsing is done according to Unix shell rules, not * Windows command interpreter rules. * Space is a separator, and backslashes are * special. Thus you cannot simply pass a @a command_line containing @@ -377,7 +377,7 @@ void spawn_command_line_async(const std::string& command_line); * separator. You need to enclose such paths with single quotes, like * "'c:\\program files\\app\\app.exe' 'e:\\folder\\argument.txt'". * - * @param command_line A command line. + * @param command_line A command line. * @param standard_output Return location for child output. * @param standard_error Return location for child errors. * @param exit_status Return location for child exit status, as returned by waitpid(). @@ -400,7 +400,7 @@ void spawn_command_line_sync(const std::string& command_line, * * @param pid The process identifier to close. */ -void spawn_close_pid(Pid pid); +void spawn_close_pid(Pid pid); /** @} group Spawn */ diff --git a/glib/src/thread.ccg b/glib/src/thread.ccg index a6f346a6..cfc38952 100644 --- a/glib/src/thread.ccg +++ b/glib/src/thread.ccg @@ -56,7 +56,7 @@ namespace Glib { // This was always meant as an internal method. It is no longer called, -// and no longer needs to be called. We are keeping it just to avoid +// and no longer needs to be called. We are keeping it just to avoid // breaking ABI, though hopefully nobody is using it anyway. // TODO: Remove this when we can break ABI. void thread_init_impl() @@ -148,10 +148,10 @@ ThreadPriority Thread::get_priority() const void thread_init(GThreadFunctions* /* vtable */) { //g_thread_init() is deprecated and now does nothing, - //so we do not even call it. That avoids a need to link to gthread-2.0, + //so we do not even call it. That avoids a need to link to gthread-2.0, //which contains the empty g_thread_init() implementation. //g_thread_init(vtable); - + Glib::thread_init_impl(); } diff --git a/glib/src/thread.hg b/glib/src/thread.hg index 1bc10dce..fb6f19b7 100644 --- a/glib/src/thread.hg +++ b/glib/src/thread.hg @@ -33,7 +33,7 @@ _IS_DEPRECATED // This whole file is deprecated. //Stop the deprecation ifdef guards around the API declarations: #undef G_DISABLE_DEPRECATED -//Stop the compiler warnings about using the deprecated API; +//Stop the compiler warnings about using the deprecated API; #define GLIB_DISABLE_DEPRECATION_WARNINGS 1 #define GLIBMM_G_DISABLE_DEPRECATED_UNDEFED 1 @@ -71,7 +71,7 @@ enum { THREAD_PRIORITY_NORMAL = GLIBMM_MACRO_DEFINITION_THREAD_PRIORITY_NORMAL } * @relates Glib::StaticRecMutex * @hideinitializer * - * @deprecated Glib::StaticRecMutex is deprecated in favour of Glib::Threads::RecMutex, which can be used statically. + * @deprecated Glib::StaticRecMutex is deprecated in favour of Glib::Threads::RecMutex, which can be used statically. */ #define GLIBMM_STATIC_REC_MUTEX_INIT { G_STATIC_REC_MUTEX_INIT } @@ -79,7 +79,7 @@ enum { THREAD_PRIORITY_NORMAL = GLIBMM_MACRO_DEFINITION_THREAD_PRIORITY_NORMAL } * @relates Glib::StaticRWLock * @hideinitializer * - * @deprecated Glib::StaticRWLock is deprecated in favour of Glib::Threads::RWLock, which can be used statically. + * @deprecated Glib::StaticRWLock is deprecated in favour of Glib::Threads::RWLock, which can be used statically. */ #define GLIBMM_STATIC_RW_LOCK_INIT { G_STATIC_RW_LOCK_INIT } @@ -87,7 +87,7 @@ enum { THREAD_PRIORITY_NORMAL = GLIBMM_MACRO_DEFINITION_THREAD_PRIORITY_NORMAL } * @relates Glib::StaticPrivate * @hideinitializer * - * @deprecated Glib::StaticPrivate is deprecated in favour of Glib::Threads::Private, which can be used statically. + * @deprecated Glib::StaticPrivate is deprecated in favour of Glib::Threads::Private, which can be used statically. */ #define GLIBMM_STATIC_PRIVATE_INIT { G_STATIC_PRIVATE_INIT } @@ -247,7 +247,7 @@ public: * @return The new Thread* on success. * @throw Glib::ThreadError * - * @deprecated Use the simpler create() method instead, because all Threads + * @deprecated Use the simpler create() method instead, because all Threads * are now joinable, and bounds and priority parameters now have no effect. */ static Thread* create(const sigc::slot<void>& slot, unsigned long stack_size, @@ -259,7 +259,7 @@ public: * @deprecated All threads are now joinable. */ bool joinable() const; - + /** Changes the priority of the thread to @a priority. * @note It is not guaranteed, that threads with different priorities really * behave accordingly. On some systems (e.g. Linux) only @c root can @@ -336,7 +336,7 @@ struct StaticMutex; * conversion to Mutex&, thus you can safely use Mutex::Lock with a * StaticMutex. * - * @deprecated Use Glib::Threads::Mutex instead, which can be used statically. + * @deprecated Use Glib::Threads::Mutex instead, which can be used statically. */ struct StaticMutex { @@ -358,7 +358,7 @@ struct StaticMutex * @relates Glib::StaticMutex * @hideinitializer * - * @deprecated Glib::StaticMutex is deprecated in favour of Glib::Threads::Mutex, which can be used statically. + * @deprecated Glib::StaticMutex is deprecated in favour of Glib::Threads::Mutex, which can be used statically. */ #define GLIBMM_STATIC_MUTEX_INIT { G_STATIC_MUTEX_INIT } @@ -630,9 +630,9 @@ private: RWLock::WriterLock& operator=(const RWLock::WriterLock&); }; -/** An opaque data structure to represent a condition. - * A @a Cond is an object that threads can block on, if they find a certain - * condition to be false. If other threads change the state of this condition +/** An opaque data structure to represent a condition. + * A @a Cond is an object that threads can block on, if they find a certain + * condition to be false. If other threads change the state of this condition * they can signal the @a Cond, such that the waiting thread is woken up. * @par Usage example: * @code @@ -670,15 +670,15 @@ public: Cond(); ~Cond(); - /** If threads are waiting for this @a Cond, exactly one of them is woken up. - * It is good practice to hold the same lock as the waiting thread, while calling + /** If threads are waiting for this @a Cond, exactly one of them is woken up. + * It is good practice to hold the same lock as the waiting thread, while calling * this method, though not required. * */ void signal(); /** If threads are waiting for this @a Cond, all of them are woken up. - * It is good practice to hold the same lock as the waiting thread, while calling + * It is good practice to hold the same lock as the waiting thread, while calling * this method, though not required. */ void broadcast(); @@ -687,12 +687,12 @@ public: * The mutex is unlocked before falling asleep and locked again before resuming. * * @param mutex a @a Mutex that is currently locked. - * + * * @note It is important to use the @a wait() and @a timed_wait() methods - * only inside a loop, which checks for the condition to be true as it is not - * guaranteed that the waiting thread will find it fulfilled, even if the signaling - * thread left the condition in that state. This is because another thread can have - * altered the condition, before the waiting thread got the chance to be woken up, + * only inside a loop, which checks for the condition to be true as it is not + * guaranteed that the waiting thread will find it fulfilled, even if the signaling + * thread left the condition in that state. This is because another thread can have + * altered the condition, before the waiting thread got the chance to be woken up, * even if the condition itself is protected by a @a Mutex. */ void wait(Mutex& mutex); @@ -702,12 +702,12 @@ public: * * @param mutex a @a Mutex that is currently locked. * @param abs_time a max time to wait. - * + * * @note It is important to use the @a wait() and @a timed_wait() methods - * only inside a loop, which checks for the condition to be true as it is not - * guaranteed that the waiting thread will find it fulfilled, even if the signaling - * thread left the condition in that state. This is because another thread can have - * altered the condition, before the waiting thread got the chance to be woken up, + * only inside a loop, which checks for the condition to be true as it is not + * guaranteed that the waiting thread will find it fulfilled, even if the signaling + * thread left the condition in that state. This is because another thread can have + * altered the condition, before the waiting thread got the chance to be woken up, * even if the condition itself is protected by a @a Mutex. */ bool timed_wait(Mutex& mutex, const Glib::TimeVal& abs_time); diff --git a/glib/src/threads.hg b/glib/src/threads.hg index 10ef5ddf..01de9689 100644 --- a/glib/src/threads.hg +++ b/glib/src/threads.hg @@ -390,9 +390,9 @@ private: RWLock::WriterLock& operator=(const RWLock::WriterLock&); }; -/** An opaque data structure to represent a condition. - * A @a Cond is an object that threads can block on, if they find a certain - * condition to be false. If other threads change the state of this condition +/** An opaque data structure to represent a condition. + * A @a Cond is an object that threads can block on, if they find a certain + * condition to be false. If other threads change the state of this condition * they can signal the @a Cond, such that the waiting thread is woken up. * @par Usage example: * @code @@ -428,15 +428,15 @@ public: Cond(); ~Cond(); - /** If threads are waiting for this @a Cond, exactly one of them is woken up. - * It is good practice to hold the same lock as the waiting thread, while calling + /** If threads are waiting for this @a Cond, exactly one of them is woken up. + * It is good practice to hold the same lock as the waiting thread, while calling * this method, though not required. * */ void signal(); /** If threads are waiting for this @a Cond, all of them are woken up. - * It is good practice to hold the same lock as the waiting thread, while calling + * It is good practice to hold the same lock as the waiting thread, while calling * this method, though not required. */ void broadcast(); @@ -445,12 +445,12 @@ public: * The mutex is unlocked before falling asleep and locked again before resuming. * * @param mutex a @a Mutex that is currently locked. - * + * * @note It is important to use the @a wait() and @a wait_until() methods - * only inside a loop, which checks for the condition to be true as it is not - * guaranteed that the waiting thread will find it fulfilled, even if the signaling - * thread left the condition in that state. This is because another thread can have - * altered the condition, before the waiting thread got the chance to be woken up, + * only inside a loop, which checks for the condition to be true as it is not + * guaranteed that the waiting thread will find it fulfilled, even if the signaling + * thread left the condition in that state. This is because another thread can have + * altered the condition, before the waiting thread got the chance to be woken up, * even if the condition itself is protected by a @a Mutex. */ void wait(Mutex& mutex); @@ -460,12 +460,12 @@ public: * * @param mutex a @a Mutex that is currently locked. * @param abs_time a max time to wait. - * + * * @note It is important to use the @a wait() and @a wait_until() methods - * only inside a loop, which checks for the condition to be true as it is not - * guaranteed that the waiting thread will find it fulfilled, even if the signaling - * thread left the condition in that state. This is because another thread can have - * altered the condition, before the waiting thread got the chance to be woken up, + * only inside a loop, which checks for the condition to be true as it is not + * guaranteed that the waiting thread will find it fulfilled, even if the signaling + * thread left the condition in that state. This is because another thread can have + * altered the condition, before the waiting thread got the chance to be woken up, * even if the condition itself is protected by a @a Mutex. */ bool wait_until(Mutex& mutex, gint64 end_time); diff --git a/glib/src/uriutils.hg b/glib/src/uriutils.hg index 6ef99d96..a1a6f890 100644 --- a/glib/src/uriutils.hg +++ b/glib/src/uriutils.hg @@ -26,12 +26,12 @@ namespace Glib * Various uri-related functions. */ -//Note that the illegal_characters and reserved_chars_allowed parameters are bytes and may not be UTF-8 +//Note that the illegal_characters and reserved_chars_allowed parameters are bytes and may not be UTF-8 //so they are not Glib::ustring. See http://bugzilla.gnome.org/show_bug.cgi?id=508773 /** Unescapes a whole escaped string. * If any of the characters in @a illegal_characters or the character zero appears - * as an escaped character in @a escaped_string then that is an error and an empty string + * as an escaped character in @a escaped_string then that is an error and an empty string * will be returned. This is useful it you want to avoid, for instance, having a * slash being expanded in an escaped path element, which might confuse pathname * handling. @@ -39,26 +39,26 @@ namespace Glib * @param escaped_string An escaped string to be unescaped. * @param illegal_characters An optional string of illegal characters not to be allowed. * @result An unescaped version of @a escaped_string. - * + * * @ingroup UriUtils * @newin{2,16} */ std::string uri_unescape_string(const std::string& escaped_string, const std::string& illegal_characters = std::string()); -//TODO: Use iterator? +//TODO: Use iterator? //char * g_uri_unescape_segment (const char *escaped_string, // const char *escaped_string_end, // const char *illegal_characters); /** Gets the scheme portion of a URI. RFC 3986 decodes the scheme as: * @code - * URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] + * URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] * @endcode * Common schemes include "file", "http", "svn+ssh", etc. * * @param uri - * @result The "Scheme" component of the URI, or an empty string on error. - * + * @result The "Scheme" component of the URI, or an empty string on error. + * * @ingroup UriUtils * @newin{2,16} */ diff --git a/glib/src/variant.ccg b/glib/src/variant.ccg index 8dc5ad80..ded44d5d 100644 --- a/glib/src/variant.ccg +++ b/glib/src/variant.ccg @@ -131,7 +131,7 @@ VariantContainerBase::create_tuple(const VariantBase& child) //static VariantContainerBase -VariantContainerBase::create_maybe(const VariantType& child_type, +VariantContainerBase::create_maybe(const VariantType& child_type, const VariantBase& child) { GVariant* g_variant = g_variant_new_maybe(child_type.gobj(), diff --git a/glib/src/variantiter.hg b/glib/src/variantiter.hg index 9ecf193e..8382ab4e 100644 --- a/glib/src/variantiter.hg +++ b/glib/src/variantiter.hg @@ -49,7 +49,7 @@ public: bool next_value(VariantBase& value); _IGNORE(g_variant_iter_next_value) - + // Ignore varargs function _IGNORE(g_variant_iter_next) }; diff --git a/glib/src/varianttype.ccg b/glib/src/varianttype.ccg index c60031e2..6cd317ec 100644 --- a/glib/src/varianttype.ccg +++ b/glib/src/varianttype.ccg @@ -41,12 +41,12 @@ VariantType& VariantType::operator=(const GVariantType* castitem) { g_variant_type_free (gobject_); } - + if(castitem) gobject_ = g_variant_type_copy(castitem); else gobject_ = 0; - + return *this; } |