ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

2004-12-21 Jeroen Zwartepoorte <jeroen@xs4all.nl>

Browse source 
* gnomevfs/Async.cs:
	* gnomevfs/Directory.cs:
	* gnomevfs/Sync.cs:
	* gnomevfs/Vfs.cs: Make the constructors private so they don't show up
	in monodoc (these classes aren't meant to be instantiated).


svn path=/trunk/gtk-sharp/; revision=38025
This commit is contained in:
Jeroen Zwartepoorte 2004-12-21 12:52:49 +00:00
parent bdf07d6a55
commit 2d8853461e
11 changed files with 164 additions and 93 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
ChangeLog
View file

@ -1,3 +1,11 @@
2004-12-21 Jeroen Zwartepoorte <jeroen@xs4all.nl>
* gnomevfs/Async.cs:
* gnomevfs/Directory.cs:
* gnomevfs/Sync.cs:
* gnomevfs/Vfs.cs: Make the constructors private so they don't show up
in monodoc (these classes aren't meant to be instantiated).
2004-12-21 Jeroen Zwartepoorte <jeroen@xs4all.nl>
* gnomevfs/Gnomevfs.metadata: Hide the auto-generated ModuleCallback

5
doc/ChangeLog
View file

@ -1,3 +1,8 @@
2004-12-21 Jeroen Zwartepoorte <jeroen@xs4all.nl>
* en/Gnome.Vfs.xml:
* en/Gnome.Vfs/*.xml: Start documenting Gnome.Vfs.
2004-12-21 Jeroen Zwartepoorte <jeroen@xs4all.nl>
* en/Gnome.Vfs/*.xml : updater run for recent changes. Remove obsolete

16
doc/en/Gnome.Vfs.xml Normal file
View file

@ -0,0 +1,16 @@
<Namespace Name="Gnome.Vfs" FullName="Gnome.Vfs" FullNameSP="Gnome.Vfs" Maintainer="Mono">
<Docs>
<summary>Library for dealing with various virtual file systems.</summary>
<remarks>
<para>
GnomeVFS is a filesystem abstraction library allowing applications plugable transparent access to a variety of "real" filesystems, from WebDAV to digital cameras, to the local filesystem. It also contains a number of other convenient file utilities such as a comphrehensive MIME database / Application registry, and a copy engine. Use of GnomeVFS ensures that an application or component will be usable by Nautilus or other GnomeVFS applications for handling the display of data from various URIs, as well.
</para>
<para>
From a user's perspective GnomeVFS enabled applications provide consistent access to their data, whether it be stored on remote servers or on their local harddisk, or even a peripheral device such as a Rio or a digital camera. Rather than having to work around the distinction between storage you can work off of and storage you can only "download" from or "upload" to, GnomeVFS allows users to store their documents and data wherever it is most convenient.
</para>
<para>
Besides providing transparent access to data methods that you might otherwise have to implement, GnomeVFS provides a number of convenience libraries for processing URIs, detecting the MIME type of files, and even figuring out which applications or components to launch to view a file or what icon to use. Writing a GnomeVFS module may also be an appropriate solution to some data access problems as it allows the developer to implement a relatively small number of functions to gain general filesystem semantics (and of course, writing a GnomeVFS module benefits other applications too!).
</para>
</remarks>
</Docs>
</Namespace>

181
doc/en/Gnome.Vfs/Async.xml
View file

@ -9,8 +9,76 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Asynchronous File Operations; POSIX-style file operations that run outside your main loop.
<example>
<code lang="C#">
public class TestAsync {
private static MainLoop loop;
private static Handle handle;
static void Main (string[] args)
{
if (args.Length != 1) {
Console.WriteLine ("Usage: TestAsync &lt;uri&gt;");
return;
}
Gnome.Vfs.Vfs.Initialize ();
Gnome.Vfs.Uri uri = new Gnome.Vfs.Uri (args[0]);
handle = Async.Open (uri, OpenMode.Read,
(int)Async.Priority.Default,
new Gnome.Vfs.AsyncCallback (OnOpen));
loop = new MainLoop ();
loop.Run ();
Gnome.Vfs.Vfs.Shutdown ();
}
private static void OnOpen (Handle handle, Result result)
{
Console.WriteLine ("Uri opened: {0}", result);
if (result != Result.Ok) {
loop.Quit ();
return;
}
byte[] buffer = new byte[1024];
Async.Read (handle, out buffer[0], (uint)buffer.Length,
new AsyncReadCallback (OnRead));
}
private static void OnRead (Handle handle, Result result, byte[] buffer,
ulong bytes_requested, ulong bytes_read)
{
Console.WriteLine ("Read: {0}", result);
if (result != Result.Ok &amp;&amp; result != Result.ErrorEof) {
loop.Quit ();
return;
}
UTF8Encoding utf8 = new UTF8Encoding ();
Console.WriteLine ("read ({0} bytes) : '{1}'", bytes_read,
utf8.GetString (buffer, 0, (int)bytes_read));
if (bytes_read != 0)
Async.Read (handle, out buffer[0], (uint)buffer.Length,
new AsyncReadCallback (OnRead));
else
Async.Close (handle, new Gnome.Vfs.AsyncCallback (OnClose));
}
private static void OnClose (Handle handle, Result result)
{
Console.WriteLine ("Close: {0}", result);
loop.Quit ();
}
}
</code>
</example></summary>
<remarks>The members of this class are all static methods and use the <see cref="T:Gnome.Vfs.Handle" /> class to reference asynchronous operations in progress.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
@ -28,8 +96,9 @@
<Parameter Name="handle" Type="Gnome.Vfs.Handle" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="handle">a <see cref="T:Gnome.Vfs.Handle" /></param>
<summary>Cancel an asynchronous operation and close all its callbacks. Its possible to still receive another call or two on the callback.</summary>
<param name="handle">
<see cref="T:Gnome.Vfs.Handle" /> of the async operation to be cancelled</param>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -44,9 +113,9 @@
<Parameter Name="callback" Type="Gnome.Vfs.AsyncCallback" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="handle">a <see cref="T:Gnome.Vfs.Handle" /></param>
<param name="callback">a <see cref="T:Gnome.Vfs.AsyncCallback" /></param>
<summary>Close a handle opened with <see cref="M:Gnome.Vfs.Async.Open" />. When the close has completed, <see cref="T:Gnome.Vfs.AsyncCallback" /> will be called with the <see cref="T:Gnome.Vfs.Result" /> of the operation.</summary>
<param name="handle">a <see cref="T:Gnome.Vfs.Handle" /> to close</param>
<param name="callback">a <see cref="T:Gnome.Vfs.AsyncCallback" /> to be called when the operation is complete</param>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -65,13 +134,13 @@
<Parameter Name="callback" Type="Gnome.Vfs.AsyncCallback" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<param name="mode">a <see cref="T:System.Int32" /></param>
<param name="exclusive">a <see cref="T:System.Boolean" /></param>
<param name="perm">a <see cref="T:System.Int32" /></param>
<param name="priority">a <see cref="T:System.Int32" /></param>
<param name="callback">a <see cref="T:Gnome.Vfs.AsyncCallback" /></param>
<summary>Create a file at uri according to mode <see cref="T:Gnome.Vfs.OpenMode" />, with permissions <see cref="T:Gnome.Vfs.FilePermissions" />. When the create has been completed <see cref="T:Gnome.Vfs.AsyncCallback" /> will be called with the <see cref="T:Gnome.Vfs.Result" />.</summary>
<param name="uri">the URI to create a file at.</param>
<param name="mode">mode to leave the file opened in after creation (or <see cref="M:Gnome.Vfs.OpenMode.None" /> to leave the file closed after creation).</param>
<param name="exclusive">Whether the file should be created in "exclusive" mode: i.e. if this flag is nonzero, operation will fail if a file with the same name already exists.</param>
<param name="perm">Bitmap representing the permissions for the newly created file (Unix style).</param>
<param name="priority">a value from <see cref="M:Gnome.Vfs.Async+Priority.Min" /> to <see cref="T:Gnome.Vfs.Async+Priority.Max" /> (normally should be <see cref="T:Gnome.Vfs.Async+Priority.Default" />) indicating the priority to assign this job in allocating threads from the thread pool.</param>
<param name="callback">a <see cref="T:Gnome.Vfs.AsyncCallback" /> to be called when the operation is complete.</param>
<returns>a <see cref="T:Gnome.Vfs.Handle" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -91,13 +160,13 @@
<Parameter Name="callback" Type="Gnome.Vfs.AsyncCallback" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri">a <see cref="T:Gnome.Vfs.Uri" /></param>
<param name="mode">a <see cref="T:System.Int32" /></param>
<param name="exclusive">a <see cref="T:System.Boolean" /></param>
<param name="perm">a <see cref="T:System.Int32" /></param>
<param name="priority">a <see cref="T:System.Int32" /></param>
<param name="callback">a <see cref="T:Gnome.Vfs.AsyncCallback" /></param>
<summary>Create a file at <see cref="T:Gnome.Vfs.Uri" /> according to mode <see cref="T:Gnome.Vfs.OpenMode" />, with permissions <see cref="T:Gnome.Vfs.FilePermissions" />. When the create has been completed <see cref="T:Gnome.Vfs.AsyncCallback" /> will be called with the <see cref="T:Gnome.Vfs.Result" />.</summary>
<param name="uri">the <see cref="T:Gnome.Vfs.Uri" /> to create a file at.</param>
<param name="mode">mode to leave the file opened in after creation (or <see cref="M:Gnome.Vfs.OpenMode.None" /> to leave the file closed after creation).</param>
<param name="exclusive">Whether the file should be created in "exclusive" mode: i.e. if this flag is nonzero, operation will fail if a file with the same name already exists.</param>
<param name="perm">Bitmap representing the permissions for the newly created file (Unix style).</param>
<param name="priority">a value from <see cref="M:Gnome.Vfs.Async+Priority.Min" /> to <see cref="T:Gnome.Vfs.Async+Priority.Max" /> (normally should be <see cref="T:Gnome.Vfs.Async+Priority.Default" />) indicating the priority to assign this job in allocating threads from the thread pool.</param>
<param name="callback">a <see cref="T:Gnome.Vfs.AsyncCallback" /> to be called when the operation is complete.</param>
<returns>a <see cref="T:Gnome.Vfs.Handle" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -115,11 +184,13 @@
<Parameter Name="callback" Type="Gnome.Vfs.AsyncCallback" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<param name="mode">a <see cref="T:System.Int32" /></param>
<param name="priority">a <see cref="T:System.Int32" /></param>
<param name="callback">a <see cref="T:Gnome.Vfs.AsyncCallback" /></param>
<summary>Open uri according to mode <see cref="T:Gnome.Vfs.OpenMode" />. Once the file has been successfully opened, <see cref="T:Gnome.Vfs.AsyncCallback" /> will be called with the <see cref="T:Gnome.Vfs.Result" />.</summary>
<param name="uri">
<see cref="T:System.String" /> of the URI to open.</param>
<param name="mode">
<see cref="T:Gnome.Vfs.OpenMode" />.</param>
<param name="priority">a value from <see cref="M:Gnome.Vfs.Async+Priority.Min" /> to <see cref="T:Gnome.Vfs.Async+Priority.Max" /> (normally should be <see cref="T:Gnome.Vfs.Async+Priority.Default" />) indicating the priority to assign this job in allocating threads from the thread pool.</param>
<param name="callback">a <see cref="T:Gnome.Vfs.AsyncCallback" /> to be called when the operation is complete.</param>
<returns>a <see cref="T:Gnome.Vfs.Handle" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -137,11 +208,13 @@
<Parameter Name="callback" Type="Gnome.Vfs.AsyncCallback" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="uri">a <see cref="T:Gnome.Vfs.Uri" /></param>
<param name="mode">a <see cref="T:System.Int32" /></param>
<param name="priority">a <see cref="T:System.Int32" /></param>
<param name="callback">a <see cref="T:Gnome.Vfs.AsyncCallback" /></param>
<summary>Open <see cref="T:Gnome.Vfs.Uri" /> according to mode <see cref="T:Gnome.Vfs.OpenMode" />. Once the file has been successfully opened, <see cref="T:Gnome.Vfs.AsyncCallback" /> will be called with the <see cref="T:Gnome.Vfs.Result" />.</summary>
<param name="uri">
<see cref="T:Gnome.Vfs.Uri" /> to open.</param>
<param name="mode">
<see cref="T:Gnome.Vfs.OpenMode" />.</param>
<param name="priority">a value from <see cref="M:Gnome.Vfs.Async+Priority.Min" /> to <see cref="T:Gnome.Vfs.Async+Priority.Max" /> (normally should be <see cref="T:Gnome.Vfs.Async+Priority.Default" />) indicating the priority to assign this job in allocating threads from the thread pool.</param>
<param name="callback">a <see cref="T:Gnome.Vfs.AsyncCallback" /> to be called when the operation is complete.</param>
<returns>a <see cref="T:Gnome.Vfs.Handle" /></returns>
<remarks>To be added</remarks>
</Docs>
@ -159,11 +232,12 @@
<Parameter Name="callback" Type="Gnome.Vfs.AsyncReadCallback" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="handle">a <see cref="T:Gnome.Vfs.Handle" /></param>
<param name="buffer">a <see cref="T:System.Byte" /></param>
<param name="bytes">a <see cref="T:System.UInt32" /></param>
<param name="callback">a <see cref="T:Gnome.Vfs.AsyncReadCallback" /></param>
<summary>Read number of bytes from the file pointed to by <see cref="T:Gnome.Vfs.Handle" /> into byte array buffer. When the operation is complete, <see cref="T:Gnome.Vfs.AsyncReadCallback" /> will be called with the <see cref="T:Gnome.Vfs.Result" /> of the operation.</summary>
<param name="handle">
<see cref="T:Gnome.Vfs.Handle" /> for the file to be read.</param>
<param name="buffer">allocated array of <see cref="T:System.Byte" /> to read into. Needs to be passed as "out buffer[0]".</param>
<param name="bytes">number of bytes to read.</param>
<param name="callback">a <see cref="T:Gnome.Vfs.AsyncReadCallback" /> to be called when the operation is complete.</param>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -180,11 +254,13 @@
<Parameter Name="callback" Type="Gnome.Vfs.AsyncCallback" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="handle">a <see cref="T:Gnome.Vfs.Handle" /></param>
<param name="whence">a <see cref="T:System.Int32" /></param>
<param name="offset">a <see cref="T:System.Int64" /></param>
<param name="callback">a <see cref="T:Gnome.Vfs.AsyncCallback" /></param>
<summary>Set the current position for reading/writing through <see cref="T:Gnome.Vfs.Handle" />. When the operation is complete, <see cref="T:Gnome.Vfs.AsyncCallback" /> will be called with the <see cref="T:Gnome.Vfs.Result" /> of the operation.</summary>
<param name="handle">
<see cref="T:Gnome.Vfs.Handle" /> for which the current position must be changed.</param>
<param name="whence">
<see cref="T:Gnome.Vfs.SeekPosition" /> value representing the starting position.</param>
<param name="offset">number of bytes to skip from the position specified by <see cref="T:Gnome.Vfs.SeekPosition" /> (a positive value means to move forward; a negative one to move backwards).</param>
<param name="callback">a <see cref="T:Gnome.Vfs.AsyncCallback" /> to be called when the operation is complete.</param>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -201,22 +277,13 @@
<Parameter Name="callback" Type="Gnome.Vfs.AsyncWriteCallback" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="handle">a <see cref="T:Gnome.Vfs.Handle" /></param>
<param name="buffer">a <see cref="T:System.Byte" /></param>
<param name="bytes">a <see cref="T:System.UInt32" /></param>
<param name="callback">a <see cref="T:Gnome.Vfs.AsyncWriteCallback" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Async ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gnome.Vfs.Async" /></returns>
<summary>Write number of bytes from buffer byte array into the file pointed to be <see cref="T:Gnome.Vfs.Handle" />. When the operation is complete, <see cref="T:Gnome.Vfs.AsyncWriteCallback" /> will be called with the <see cref="T:Gnome.Vfs.Result" /> of the operation.</summary>
<param name="handle">
<see cref="T:Gnome.Vfs.Handle" /> for the file to be written.</param>
<param name="buffer">
<see cref="T:System.Byte" /> array containing data to be written. Needs to be passed as "out buffer[0]".</param>
<param name="bytes">number of bytes to write.</param>
<param name="callback">a <see cref="T:Gnome.Vfs.AsyncWriteCallback" /> to be called when the operation is complete.</param>
<remarks>To be added</remarks>
</Docs>
</Member>

13
doc/en/Gnome.Vfs/Directory.xml
View file

@ -200,16 +200,5 @@
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Directory ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gnome.Vfs.Directory" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

13
doc/en/Gnome.Vfs/Sync.xml
View file

@ -252,16 +252,5 @@
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Sync ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gnome.Vfs.Sync" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

13
doc/en/Gnome.Vfs/Vfs.xml
View file

@ -213,17 +213,6 @@
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Vfs ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gnome.Vfs.Vfs" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Initialized">
<MemberSignature Language="C#" Value="public static bool Initialized { get; };" />
<MemberType>Property</MemberType>
@ -238,4 +227,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

2
gnomevfs/Async.cs
View file

@ -29,6 +29,8 @@ namespace Gnome.Vfs {
Default = 0,
Max = 10
}
private Async () {}
[DllImport ("gnomevfs-2")]
private static extern void gnome_vfs_async_cancel (IntPtr handle);

2
gnomevfs/Directory.cs
View file

@ -24,6 +24,8 @@ using System.Runtime.InteropServices;
namespace Gnome.Vfs {
public class Directory {
private Directory () {}
public static FileInfo[] GetEntries (Uri uri)
{
return GetEntries (uri.ToString ());

2
gnomevfs/Sync.cs
View file

@ -24,6 +24,8 @@ using System.Runtime.InteropServices;
namespace Gnome.Vfs {
public class Sync {
private Sync () {}
[DllImport ("gnomevfs-2")]
private static extern Result gnome_vfs_close (IntPtr handle);

2
gnomevfs/Vfs.cs
View file

@ -24,6 +24,8 @@ using System.Runtime.InteropServices;
namespace Gnome.Vfs {
public class Vfs {
private Vfs () {}
[DllImport ("gnomevfs-2")]
static extern bool gnome_vfs_init ();