hi this patch cleans up documentation in gnome-vfs-xfer.[c-h], mainly i just took out the documentation of the enums from gnome-vfs-xfer.h and put it into tmp/gnome-vfs-xfer.sgml, this is the same that gtk docs do. Also i migrated the way to built the documentation from sgml to xml, this has been also done in gtk. Should i commit? -- Diego González <diego pemas net>
Index: gnome-vfs-docs.sgml =================================================================== RCS file: /cvs/gnome/gnome-vfs/doc/gnome-vfs-docs.sgml,v retrieving revision 1.12 diff -u -r1.12 gnome-vfs-docs.sgml --- gnome-vfs-docs.sgml 16 Jun 2002 10:15:24 -0000 1.12 +++ gnome-vfs-docs.sgml 6 Dec 2002 15:40:52 -0000 @@ -1,39 +1,40 @@ -<!doctype book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [ -<!ENTITY writing-modules SYSTEM "writing-modules.sgml"> -<!ENTITY installing-mime-data SYSTEM "installing-mime-data.sgml"> -<!ENTITY about SYSTEM "about.sgml"> -<!ENTITY gnome-vfs-GnomeVfsMetadata SYSTEM "sgml/gnome-vfs-metadata.sgml"> -<!ENTITY gnome-vfs-GnomeVFSMIMEMonitor SYSTEM "sgml/gnome-vfs-mime-monitor.sgml"> -<!ENTITY gnome-vfs-file-size SYSTEM "sgml/gnome-vfs-file-size.sgml"> -<!ENTITY gnome-vfs-utils SYSTEM "sgml/gnome-vfs-utils.sgml"> -<!ENTITY gnome-vfs-application-registry SYSTEM "sgml/gnome-vfs-application-registry.sgml"> -<!ENTITY gnome-vfs-transform SYSTEM "sgml/gnome-vfs-transform.sgml"> -<!ENTITY gnome-vfs-async-ops SYSTEM "sgml/gnome-vfs-async-ops.sgml"> -<!ENTITY gnome-vfs-ops SYSTEM "sgml/gnome-vfs-ops.sgml"> -<!ENTITY gnome-vfs-ssl SYSTEM "sgml/gnome-vfs-ssl.sgml"> -<!ENTITY gnome-vfs-uri SYSTEM "sgml/gnome-vfs-uri.sgml"> -<!ENTITY gnome-vfs-iobuf SYSTEM "sgml/gnome-vfs-iobuf.sgml"> -<!ENTITY gnome-vfs-standard-callbacks SYSTEM "sgml/gnome-vfs-standard-callbacks.sgml"> -<!ENTITY gnome-vfs-inet-connection SYSTEM "sgml/gnome-vfs-inet-connection.sgml"> -<!ENTITY gnome-vfs-socket SYSTEM "sgml/gnome-vfs-socket.sgml"> -<!ENTITY gnome-vfs-parse-ls SYSTEM "sgml/gnome-vfs-parse-ls.sgml"> -<!ENTITY gnome-vfs-module-callback SYSTEM "sgml/gnome-vfs-module-callback.sgml"> -<!ENTITY gnome-vfs-context SYSTEM "sgml/gnome-vfs-context.sgml"> -<!ENTITY gnome-vfs-file-info SYSTEM "sgml/gnome-vfs-file-info.sgml"> -<!ENTITY gnome-vfs-method SYSTEM "sgml/gnome-vfs-method.sgml"> -<!ENTITY gnome-vfs-directory SYSTEM "sgml/gnome-vfs-directory.sgml"> -<!ENTITY gnome-vfs-result SYSTEM "sgml/gnome-vfs-result.sgml"> -<!ENTITY gnome-vfs-mime-database SYSTEM "sgml/gnome-vfs-mime-database.sgml"> -<!ENTITY gnome-vfs-find-directory SYSTEM "sgml/gnome-vfs-find-directory.sgml"> -<!ENTITY gnome-vfs-module SYSTEM "sgml/gnome-vfs-module.sgml"> -<!ENTITY gnome-vfs-module-shared SYSTEM "sgml/gnome-vfs-module-shared.sgml"> -<!ENTITY gnome-vfs-module-callback-module-api SYSTEM "sgml/gnome-vfs-module-callback-module-api.sgml"> -<!ENTITY gnome-vfs-init SYSTEM "sgml/gnome-vfs-init.sgml"> -<!ENTITY gnome-vfs-mime SYSTEM "sgml/gnome-vfs-mime.sgml"> -<!ENTITY gnome-vfs-cancellation SYSTEM "sgml/gnome-vfs-cancellation.sgml"> -<!ENTITY gnome-vfs-xfer SYSTEM "sgml/gnome-vfs-xfer.sgml"> -<!ENTITY gnome-vfs-socket-buffer SYSTEM "sgml/gnome-vfs-socket-buffer.sgml"> -<!ENTITY gnome-vfs-monitor SYSTEM "sgml/gnome-vfs-monitor.sgml"> +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [ +<!ENTITY writing-modules SYSTEM "writing-modules.xml"> +<!ENTITY installing-mime-data SYSTEM "installing-mime-data.xml"> +<!ENTITY about SYSTEM "about.xml"> +<!ENTITY gnome-vfs-GnomeVfsMetadata SYSTEM "xml/gnome-vfs-metadata.xml"> +<!ENTITY gnome-vfs-GnomeVFSMIMEMonitor SYSTEM "xml/gnome-vfs-mime-monitor.xml"> +<!ENTITY gnome-vfs-file-size SYSTEM "xml/gnome-vfs-file-size.xml"> +<!ENTITY gnome-vfs-utils SYSTEM "xml/gnome-vfs-utils.xml"> +<!ENTITY gnome-vfs-application-registry SYSTEM "xml/gnome-vfs-application-registry.xml"> +<!ENTITY gnome-vfs-transform SYSTEM "xml/gnome-vfs-transform.xml"> +<!ENTITY gnome-vfs-async-ops SYSTEM "xml/gnome-vfs-async-ops.xml"> +<!ENTITY gnome-vfs-ops SYSTEM "xml/gnome-vfs-ops.xml"> +<!ENTITY gnome-vfs-ssl SYSTEM "xml/gnome-vfs-ssl.xml"> +<!ENTITY gnome-vfs-uri SYSTEM "xml/gnome-vfs-uri.xml"> +<!ENTITY gnome-vfs-standard-callbacks SYSTEM "xml/gnome-vfs-standard-callbacks.xml"> +<!ENTITY gnome-vfs-inet-connection SYSTEM "xml/gnome-vfs-inet-connection.xml"> +<!ENTITY gnome-vfs-socket SYSTEM "xml/gnome-vfs-socket.xml"> +<!ENTITY gnome-vfs-parse-ls SYSTEM "xml/gnome-vfs-parse-ls.xml"> +<!ENTITY gnome-vfs-module-callback SYSTEM "xml/gnome-vfs-module-callback.xml"> +<!ENTITY gnome-vfs-context SYSTEM "xml/gnome-vfs-context.xml"> +<!ENTITY gnome-vfs-file-info SYSTEM "xml/gnome-vfs-file-info.xml"> +<!ENTITY gnome-vfs-method SYSTEM "xml/gnome-vfs-method.xml"> +<!ENTITY gnome-vfs-directory SYSTEM "xml/gnome-vfs-directory.xml"> +<!ENTITY gnome-vfs-result SYSTEM "xml/gnome-vfs-result.xml"> +<!ENTITY gnome-vfs-mime-database SYSTEM "xml/gnome-vfs-mime-database.xml"> +<!ENTITY gnome-vfs-find-directory SYSTEM "xml/gnome-vfs-find-directory.xml"> +<!ENTITY gnome-vfs-module SYSTEM "xml/gnome-vfs-module.xml"> +<!ENTITY gnome-vfs-module-shared SYSTEM "xml/gnome-vfs-module-shared.xml"> +<!ENTITY gnome-vfs-module-callback-module-api SYSTEM "xml/gnome-vfs-module-callback-module-api.xml"> +<!ENTITY gnome-vfs-init SYSTEM "xml/gnome-vfs-init.xml"> +<!ENTITY gnome-vfs-mime SYSTEM "xml/gnome-vfs-mime.xml"> +<!ENTITY gnome-vfs-cancellation SYSTEM "xml/gnome-vfs-cancellation.xml"> +<!ENTITY gnome-vfs-xfer SYSTEM "xml/gnome-vfs-xfer.xml"> +<!ENTITY gnome-vfs-socket-buffer SYSTEM "xml/gnome-vfs-socket-buffer.xml"> +<!ENTITY gnome-vfs-monitor SYSTEM "xml/gnome-vfs-monitor.xml"> ]> <book id="index"> <bookinfo> @@ -143,7 +144,6 @@ &gnome-vfs-module; &gnome-vfs-module-shared; &gnome-vfs-module-callback-module-api; - &gnome-vfs-iobuf; &gnome-vfs-ssl; &gnome-vfs-context; &gnome-vfs-socket; Index: Makefile.am =================================================================== RCS file: /cvs/gnome/gnome-vfs/doc/Makefile.am,v retrieving revision 1.10 diff -u -r1.10 Makefile.am --- Makefile.am 16 Jun 2002 07:33:24 -0000 1.10 +++ Makefile.am 6 Dec 2002 15:40:52 -0000 @@ -14,7 +14,7 @@ SCAN_OPTIONS= # Extra options to supply to gtkdoc-mkdb -MKDB_OPTIONS= +MKDB_OPTIONS=--sgml-mode --output-format=xml # Extra options to supply to gtkdoc-fixref FIXXREF_OPTIONS= Index: tmpl/gnome-vfs-xfer.sgml =================================================================== RCS file: /cvs/gnome/gnome-vfs/doc/tmpl/gnome-vfs-xfer.sgml,v retrieving revision 1.2 diff -u -r1.2 gnome-vfs-xfer.sgml --- tmpl/gnome-vfs-xfer.sgml 2 Nov 2002 09:13:20 -0000 1.2 +++ tmpl/gnome-vfs-xfer.sgml 6 Dec 2002 15:40:52 -0000 @@ -21,90 +21,112 @@ </para> - GNOME_VFS_XFER_DEFAULT: + GNOME_VFS_XFER_DEFAULT: Default behavior. Which is to do a straight one +to one copy. @GNOME_VFS_XFER_UNUSED_1: - GNOME_VFS_XFER_FOLLOW_LINKS: + GNOME_VFS_XFER_FOLLOW_LINKS: This means follow the value of the symbolic +link when copying. (ie treat a symbolic link as a directory) @GNOME_VFS_XFER_UNUSED_2: - GNOME_VFS_XFER_RECURSIVE: - GNOME_VFS_XFER_SAMEFS: - GNOME_VFS_XFER_DELETE_ITEMS: + GNOME_VFS_XFER_RECURSIVE: Do a recursive copy of the source to the +destination. Equivalent to the cp -r option in GNU cp. + GNOME_VFS_XFER_SAMEFS: Allow copying onto the same filesystem. + GNOME_VFS_XFER_DELETE_ITEMS: Equivalent to a mv. Where you will copy the +contents of the source to the destination and then remove data from the +source URI. @GNOME_VFS_XFER_EMPTY_DIRECTORIES: - GNOME_VFS_XFER_NEW_UNIQUE_DIRECTORY: - GNOME_VFS_XFER_REMOVESOURCE: - GNOME_VFS_XFER_USE_UNIQUE_NAMES: + GNOME_VFS_XFER_NEW_UNIQUE_DIRECTORY: Cill create a directory if it doesn't +exist in the destination area. Useful with the GNOME_VFS_XFER_RECURSIVE xfer +option. + GNOME_VFS_XFER_REMOVESOURCE: Remove the source data after whatever xfer +option has been taken. + GNOME_VFS_XFER_USE_UNIQUE_NAMES: Check to make sure that what you copy onto +the destination is not overwritten. It will only copy the unique items from +the source to the destination. +GNOME_VFS_XFER_LINK_ITEMS: @GNOME_VFS_XFER_LINK_ITEMS: @GNOME_VFS_XFER_FOLLOW_LINKS_RECURSIVE: <!-- ##### ENUM GnomeVFSXferProgressStatus ##### --> <para> - +Progress status, to be reported to the caller of the transfer operation. </para> @GNOME_VFS_XFER_PROGRESS_STATUS_OK: @GNOME_VFS_XFER_PROGRESS_STATUS_VFSERROR: @GNOME_VFS_XFER_PROGRESS_STATUS_OVERWRITE: - GNOME_VFS_XFER_PROGRESS_STATUS_DUPLICATE: + GNOME_VFS_XFER_PROGRESS_STATUS_DUPLICATE: During the duplicate status the +progress callback is asked to supply a new unique name. <!-- ##### ENUM GnomeVFSXferOverwriteMode ##### --> <para> - +This specifies the different ways to deal with overwriting during a +transfer operation. </para> - GNOME_VFS_XFER_OVERWRITE_MODE_ABORT: - GNOME_VFS_XFER_OVERWRITE_MODE_QUERY: - GNOME_VFS_XFER_OVERWRITE_MODE_REPLACE: - GNOME_VFS_XFER_OVERWRITE_MODE_SKIP: + GNOME_VFS_XFER_OVERWRITE_MODE_ABORT: Aborts the transfer with and error +(GNOME_VFS_ERROR_FILEEXISTS). + GNOME_VFS_XFER_OVERWRITE_MODE_QUERY: Invoke the progress callback with a +GNOME_VFS_XFER_PROGRESS_STATUS_OVERWRITE status code. + GNOME_VFS_XFER_OVERWRITE_MODE_REPLACE: Replace the files silently. + GNOME_VFS_XFER_OVERWRITE_MODE_SKIP: Skip duplicate files silenty. <!-- ##### ENUM GnomeVFSXferOverwriteAction ##### --> <para> - +This defines the actions to perform before a file is being overwritten +(i.e., these are the answers that can be given to a replace query). </para> - GNOME_VFS_XFER_OVERWRITE_ACTION_ABORT: - GNOME_VFS_XFER_OVERWRITE_ACTION_REPLACE: - GNOME_VFS_XFER_OVERWRITE_ACTION_REPLACE_ALL: - GNOME_VFS_XFER_OVERWRITE_ACTION_SKIP: - GNOME_VFS_XFER_OVERWRITE_ACTION_SKIP_ALL: + GNOME_VFS_XFER_OVERWRITE_ACTION_ABORT: Abort the transfer. + GNOME_VFS_XFER_OVERWRITE_ACTION_REPLACE: Replace the existing file. + GNOME_VFS_XFER_OVERWRITE_ACTION_REPLACE_ALL: Replace the existing file, +and all future files without prompting the callback. + GNOME_VFS_XFER_OVERWRITE_ACTION_SKIP: Don't copy over the existing file. + GNOME_VFS_XFER_OVERWRITE_ACTION_SKIP_ALL: Don't copy over the existing file, +and all future files without prompting the callback. <!-- ##### ENUM GnomeVFSXferErrorMode ##### --> <para> </para> - GNOME_VFS_XFER_ERROR_MODE_ABORT: - GNOME_VFS_XFER_ERROR_MODE_QUERY: + GNOME_VFS_XFER_ERROR_MODE_ABORT: The operation was aborted by some sort of +signal that interrupted the transfer. + GNOME_VFS_XFER_ERROR_MODE_QUERY: No error occured. Invoke the progress +callback with a GNOME_VFS_XFER_PROGRESS_STATUS_VFSERROR status code. <!-- ##### ENUM GnomeVFSXferErrorAction ##### --> <para> - +Defines the possible actions to be performed after an error has occurred. </para> - GNOME_VFS_XFER_ERROR_ACTION_ABORT: - GNOME_VFS_XFER_ERROR_ACTION_RETRY: - GNOME_VFS_XFER_ERROR_ACTION_SKIP: + GNOME_VFS_XFER_ERROR_ACTION_ABORT: Interrupt operation and return GNOME_VFS_ERROR_INTERRUPTED. + GNOME_VFS_XFER_ERROR_ACTION_RETRY: Try the same operation again. + GNOME_VFS_XFER_ERROR_ACTION_SKIP: Skip this file and continue normally. <!-- ##### ENUM GnomeVFSXferPhase ##### --> <para> - -</para> - - GNOME_VFS_XFER_PHASE_INITIAL: - GNOME_VFS_XFER_CHECKING_DESTINATION: - GNOME_VFS_XFER_PHASE_COLLECTING: - GNOME_VFS_XFER_PHASE_READYTOGO: - GNOME_VFS_XFER_PHASE_OPENSOURCE: - GNOME_VFS_XFER_PHASE_OPENTARGET: - GNOME_VFS_XFER_PHASE_COPYING: - GNOME_VFS_XFER_PHASE_MOVING: - GNOME_VFS_XFER_PHASE_READSOURCE: - GNOME_VFS_XFER_PHASE_WRITETARGET: - GNOME_VFS_XFER_PHASE_CLOSESOURCE: - GNOME_VFS_XFER_PHASE_CLOSETARGET: - GNOME_VFS_XFER_PHASE_DELETESOURCE: - GNOME_VFS_XFER_PHASE_SETATTRIBUTES: - GNOME_VFS_XFER_PHASE_FILECOMPLETED: - GNOME_VFS_XFER_PHASE_CLEANUP: - GNOME_VFS_XFER_PHASE_COMPLETED: +This specifies the current phase in the transfer operation. Phases whose comments +are marked with (*) are always reported in "normal" (i.e. no error) condition; the +other ones are only reported if an error happens in that specific phase. +</para> + + GNOME_VFS_XFER_PHASE_INITIAL: Initial phase. + GNOME_VFS_XFER_CHECKING_DESTINATION: Checking if destination can handle move/copy. + GNOME_VFS_XFER_PHASE_COLLECTING: Collecting file list. + GNOME_VFS_XFER_PHASE_READYTOGO: File list collected (*). + GNOME_VFS_XFER_PHASE_OPENSOURCE: Opening source file for reading. + GNOME_VFS_XFER_PHASE_OPENTARGET: Creating target file for copy. + GNOME_VFS_XFER_PHASE_COPYING: Copying data from source to target (*). + GNOME_VFS_XFER_PHASE_MOVING: Moving file from source to target (*). + GNOME_VFS_XFER_PHASE_READSOURCE: Reading data from source file. + GNOME_VFS_XFER_PHASE_WRITETARGET: Writing data to target file. + GNOME_VFS_XFER_PHASE_CLOSESOURCE: Closing source file. + GNOME_VFS_XFER_PHASE_CLOSETARGET: Closing target file. + GNOME_VFS_XFER_PHASE_DELETESOURCE: Deleting source file. + GNOME_VFS_XFER_PHASE_SETATTRIBUTES: Setting attributes on target file. + GNOME_VFS_XFER_PHASE_FILECOMPLETED: Go to the next file (*). + GNOME_VFS_XFER_PHASE_CLEANUP: Cleaning up after a move (removing source files, etc.). + GNOME_VFS_XFER_PHASE_COMPLETED: Operation finished (*). @GNOME_VFS_XFER_NUM_PHASES: <!-- ##### TYPEDEF GnomeVFSXferProgressInfo ##### -->
Index: gnome-vfs-xfer.c
===================================================================
RCS file: /cvs/gnome/gnome-vfs/libgnomevfs/gnome-vfs-xfer.c,v
retrieving revision 1.101
diff -u -r1.101 gnome-vfs-xfer.c
--- gnome-vfs-xfer.c 29 Oct 2002 10:37:22 -0000 1.101
+++ gnome-vfs-xfer.c 6 Dec 2002 15:39:43 -0000
@@ -2324,49 +2324,19 @@
* gnome_vfs_xfer_uri:
* @source_uri: This is the location of where your data resides.
* @target_uri: This is the location of where you want your data to go.
- * @xfer_options: Set the kind of transfers you want. These are:
- * GNOME_VFS_XFER_DEFAULT: Default behavior. Which is to do a straight one to
- * one copy.
- * GNOME_VFS_XFER_FOLLOW_LINKS: This means follow the value of the symbolic
- * link when copying. (ie treat a symbolic link as a directory)
- * GNOME_VFS_RECURSIVE: Do a recursive copy of the source to the destination.
- * Equivalent to the cp -r option in GNU cp.
- * GNOME_VFS_XFER_SAME_FS: This only allows copying onto the same filesystem.
- * GNOME_VFS_DELETE_ITEM: This is equivalent to a mv. Where you will copy the
- * contents of the source to the destination and then remove data from the
- * source URI.
- * GNOME_VFS_XFER_EMPTY_DIRECTORIES: <TBA>
- * GNOME_VFS_XFER_NEW_UNIQUE_DIRECTORY: This will create a directory if it
- * doesn't exist in the destination area. Useful with the
- * GNOME_VFS_XFER_RECURSIVE xfer option.
- * GNOME_VFS_XFER_REMOVESOURCE: This option will remove the source data after
- * whatever xfer option has been taken.
- * GNOME_VFS_USE_UNIQUE_NAMES: This is a check ot make sure that what you copy
- * onto the destination is not overwritten. It will only copy the unique items
- * from the source to the destjnation.
- * GNOME_VFS_XFER_LINK_ITEMS: <TBA>
+ * @xfer_options: Set the kind of transfers you want.
* @error_mode: When this function returns you need to check the error code
- * for the results of the copy. The results are generally:
- * GNOME_VFS_XFER_ERROR_MODE_ABORT: This means that the operation was aborted
- * by some sort of signal that interrupted the transfer.
- * GNOME_VFS_ERROR_MODE_QUERY: This means that no error has occured and that
- * you should query with the GNOME_VFS_XFER_PROGRESS_STATUS_VFSERROR. See
+ * for the results of the copy.
* @overwrite_mode: This sets the options to deal with data that are duplicate
- * between the source and the destination. Your choices are:
- * GNOME_VFS_XFER_OVERWRITE_MODE_ABORT: This means abort the transfer if you
- * see duplicate data.
- * GNOME_VFS_XFER_OVERWRITE_MODE_REPLACE: Replace the files silently. Don't
- * worry be happy.
- * GNOME_VFS_XFER_OVERWRITE_MODE_SKIP: Skip duplicate files silenty.
- * target.
+ * between the source and the destination.
* @progress_callback: This is an important call back because this is how you
* communicate with your copy process.
* @data: Data to be want passed back in callbacks from the xfer engine
*
* This function will allow a person to copy data from one location to another.
* The location is specified using a URIs as the means to describe the location
- * of the data. Like any copy there are several options that can be set.
- * These can be set using the xfer_options. In addition there are callback
+ * of the data. Like any copy there are several options that can be set.
+ * These can be set using the xfer_options. In addition there are callback
* mechanisms and error codes to provide feedback in the copy
* process.
*
Index: gnome-vfs-xfer.h
===================================================================
RCS file: /cvs/gnome/gnome-vfs/libgnomevfs/gnome-vfs-xfer.h,v
retrieving revision 1.12
diff -u -r1.12 gnome-vfs-xfer.h
--- gnome-vfs-xfer.h 29 Oct 2002 10:37:22 -0000 1.12
+++ gnome-vfs-xfer.h 6 Dec 2002 15:39:43 -0000
@@ -53,37 +53,18 @@
GNOME_VFS_XFER_PROGRESS_STATUS_OK = 0,
GNOME_VFS_XFER_PROGRESS_STATUS_VFSERROR = 1,
GNOME_VFS_XFER_PROGRESS_STATUS_OVERWRITE = 2,
- /* during the duplicate status the progress callback is asked to
- supply a new unique name */
GNOME_VFS_XFER_PROGRESS_STATUS_DUPLICATE = 3
} GnomeVFSXferProgressStatus;
/* The different ways to deal with overwriting during a transfer operation. */
typedef enum {
- /* Interrupt transferring with an error (GNOME_VFS_ERROR_FILEEXISTS). */
GNOME_VFS_XFER_OVERWRITE_MODE_ABORT = 0,
- /* Invoke the progress callback with a
- `GNOME_VFS_XFER_PROGRESS_STATUS_OVERWRITE' status code. */
GNOME_VFS_XFER_OVERWRITE_MODE_QUERY = 1,
- /* Overwrite files silently. */
GNOME_VFS_XFER_OVERWRITE_MODE_REPLACE = 2,
- /* Ignore files silently. */
GNOME_VFS_XFER_OVERWRITE_MODE_SKIP = 3
} GnomeVFSXferOverwriteMode;
-/**
- * GnomeVFSXferOverwriteAction:
- * @GNOME_VFS_XFER_OVERWRITE_ACTION_ABORT: abort the transfer
- * @GNOME_VFS_XFER_OVERWRITE_ACTION_REPLACE: replace the existing file
- * @GNOME_VFS_XFER_OVERWRITE_ACTION_REPLACE_ALL: replace the existing file, and all future files
- * without prompting the callback.
- * @GNOME_VFS_XFER_OVERWRITE_ACTION_SKIP: don't copy over the existing file
- * @GNOME_VFS_XFER_OVERWRITE_ACTION_SKIP_ALL: don't copy over the existing file, and all future
- * files without prompting the callback.
- *
- * This defines the actions to perform before a file is being overwritten
- * (i.e., these are the answers that can be given to a replace query).
- **/
+/* Actions to perform before a file is overwritten */
typedef enum {
GNOME_VFS_XFER_OVERWRITE_ACTION_ABORT = 0,
GNOME_VFS_XFER_OVERWRITE_ACTION_REPLACE = 1,
@@ -93,63 +74,35 @@
} GnomeVFSXferOverwriteAction;
typedef enum {
- /* Interrupt transferring with an error (code returned is code of the
- operation that has caused the error). */
GNOME_VFS_XFER_ERROR_MODE_ABORT = 0,
- /* Invoke the progress callback with a
- `GNOME_VFS_XFER_PROGRESS_STATUS_VFSERROR' status code. */
GNOME_VFS_XFER_ERROR_MODE_QUERY = 1,
} GnomeVFSXferErrorMode;
-/* This defines the possible actions to be performed after an error has
- occurred. */
+/* Defines the possible actions to be performed after an error has occurred. */
typedef enum {
- /* Interrupt operation and return `GNOME_VFS_ERROR_INTERRUPTED'. */
GNOME_VFS_XFER_ERROR_ACTION_ABORT = 0,
- /* Try the same operation again. */
GNOME_VFS_XFER_ERROR_ACTION_RETRY = 1,
- /* Skip this file and continue normally. */
GNOME_VFS_XFER_ERROR_ACTION_SKIP = 2
} GnomeVFSXferErrorAction;
-/* This specifies the current phase in the transfer operation. Phases whose
- comments are marked with `(*)' are always reported in "normal" (i.e. no
- error) condition; the other ones are only reported if an error happens in
- that specific phase. */
+/* This specifies the current phase in the transfer operation. */
typedef enum {
- /* Initial phase */
GNOME_VFS_XFER_PHASE_INITIAL,
- /* Checking if destination can handle move/copy */
GNOME_VFS_XFER_CHECKING_DESTINATION,
- /* Collecting file list */
GNOME_VFS_XFER_PHASE_COLLECTING,
- /* File list collected (*) */
GNOME_VFS_XFER_PHASE_READYTOGO,
- /* Opening source file for reading */
GNOME_VFS_XFER_PHASE_OPENSOURCE,
- /* Creating target file for copy */
GNOME_VFS_XFER_PHASE_OPENTARGET,
- /* Copying data from source to target (*) */
GNOME_VFS_XFER_PHASE_COPYING,
- /* Moving file from source to target (*) */
GNOME_VFS_XFER_PHASE_MOVING,
- /* Reading data from source file */
GNOME_VFS_XFER_PHASE_READSOURCE,
- /* Writing data to target file */
GNOME_VFS_XFER_PHASE_WRITETARGET,
- /* Closing source file */
GNOME_VFS_XFER_PHASE_CLOSESOURCE,
- /* Closing target file */
GNOME_VFS_XFER_PHASE_CLOSETARGET,
- /* Deleting source file */
GNOME_VFS_XFER_PHASE_DELETESOURCE,
- /* Setting attributes on target file */
GNOME_VFS_XFER_PHASE_SETATTRIBUTES,
- /* Go to the next file (*) */
GNOME_VFS_XFER_PHASE_FILECOMPLETED,
- /* cleaning up after a move (removing source files, etc.) */
GNOME_VFS_XFER_PHASE_CLEANUP,
- /* Operation finished (*) */
GNOME_VFS_XFER_PHASE_COMPLETED,
GNOME_VFS_XFER_NUM_PHASES
} GnomeVFSXferPhase;
Attachment:
signature.asc
Description: This is a digitally signed message part