Remove Store POD whitelist Methods that weren't documented in the Perl bindings are made private.
Project: http://git-wip-us.apache.org/repos/asf/lucy/repo Commit: http://git-wip-us.apache.org/repos/asf/lucy/commit/920a7dd8 Tree: http://git-wip-us.apache.org/repos/asf/lucy/tree/920a7dd8 Diff: http://git-wip-us.apache.org/repos/asf/lucy/diff/920a7dd8 Branch: refs/heads/master Commit: 920a7dd81912ad6240d60a5e62ba2f87add9ecf9 Parents: 345fa59 Author: Nick Wellnhofer <[email protected]> Authored: Sun Aug 23 13:36:33 2015 +0200 Committer: Nick Wellnhofer <[email protected]> Committed: Tue Aug 25 12:45:49 2015 +0200 ---------------------------------------------------------------------- core/Lucy/Store/CompoundFileReader.cfh | 2 +- core/Lucy/Store/FSFolder.cfh | 10 ++++---- core/Lucy/Store/Folder.cfh | 32 +++++++++++++------------- core/Lucy/Store/RAMFolder.cfh | 10 ++++---- perl/buildlib/Lucy/Build/Binding/Store.pm | 15 ------------ 5 files changed, 27 insertions(+), 42 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucy/blob/920a7dd8/core/Lucy/Store/CompoundFileReader.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Store/CompoundFileReader.cfh b/core/Lucy/Store/CompoundFileReader.cfh index fc24d2b..f669c75 100644 --- a/core/Lucy/Store/CompoundFileReader.cfh +++ b/core/Lucy/Store/CompoundFileReader.cfh @@ -55,7 +55,7 @@ class Lucy::Store::CompoundFileReader nickname CFReader void Set_Path(CompoundFileReader *self, String *path); - public void + void Close(CompoundFileReader *self); public void http://git-wip-us.apache.org/repos/asf/lucy/blob/920a7dd8/core/Lucy/Store/FSFolder.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Store/FSFolder.cfh b/core/Lucy/Store/FSFolder.cfh index 971aa18..6408420 100644 --- a/core/Lucy/Store/FSFolder.cfh +++ b/core/Lucy/Store/FSFolder.cfh @@ -38,16 +38,16 @@ public class Lucy::Store::FSFolder inherits Lucy::Store::Folder { /** Attempt to create the directory specified by `path`. */ - public void + void Initialize(FSFolder *self); /** Verify that `path` is a directory. TODO: check * permissions. */ - public bool + bool Check(FSFolder *self); - public void + void Close(FSFolder *self); incremented nullable FileHandle* @@ -72,10 +72,10 @@ public class Lucy::Store::FSFolder inherits Lucy::Store::Folder { bool Local_Delete(FSFolder *self, String *name); - public bool + bool Rename(FSFolder *self, String* from, String *to); - public bool + bool Hard_Link(FSFolder *self, String *from, String *to); } http://git-wip-us.apache.org/repos/asf/lucy/blob/920a7dd8/core/Lucy/Store/Folder.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Store/Folder.cfh b/core/Lucy/Store/Folder.cfh index 778b12d..49134ad 100644 --- a/core/Lucy/Store/Folder.cfh +++ b/core/Lucy/Store/Folder.cfh @@ -19,7 +19,7 @@ parcel Lucy; /** Abstract class representing a directory. * * A "file" within a Folder might be a real file on disk -- or it might be a - * RAM buffer. Similarly, [](cfish:.Delete) might delete a file from the file system, or + * RAM buffer. Similarly, Delete() might delete a file from the file system, or * a key-value pair from a hash, or something else. * * The archetypal implementation of Folder, @@ -39,7 +39,7 @@ public abstract class Lucy::Store::Folder inherits Clownfish::Obj { /** Getter for `path` member var. */ - public String* + String* Get_Path(Folder *self); /** Setter for `path` member var. @@ -53,7 +53,7 @@ public abstract class Lucy::Store::Folder inherits Clownfish::Obj { * @param path A relative filepath. * @return an OutStream. */ - public incremented nullable OutStream* + incremented nullable OutStream* Open_Out(Folder *self, String *path); /** Open an InStream, or set the global error object returned by @@ -62,7 +62,7 @@ public abstract class Lucy::Store::Folder inherits Clownfish::Obj { * @param path A relative filepath. * @return an InStream. */ - public incremented nullable InStream* + incremented nullable InStream* Open_In(Folder *self, String *path); /** Open a FileHandle, or set the global error object returned by @@ -72,7 +72,7 @@ public abstract class Lucy::Store::Folder inherits Clownfish::Obj { * @param flags FileHandle flags. * @return a FileHandle. */ - public incremented nullable FileHandle* + incremented nullable FileHandle* Open_FileHandle(Folder *self, String *path, uint32_t flags); /** Open a DirHandle or set the global error object returned by @@ -82,7 +82,7 @@ public abstract class Lucy::Store::Folder inherits Clownfish::Obj { * empty or NULL, returns a DirHandle for this Folder. * @return a DirHandle. */ - public incremented nullable DirHandle* + incremented nullable DirHandle* Open_Dir(Folder *self, String *path = NULL); /** Create a subdirectory. @@ -91,7 +91,7 @@ public abstract class Lucy::Store::Folder inherits Clownfish::Obj { * @return true on success, false on failure (sets the global error object * returned by [](cfish:cfish.Err.get_error)). */ - public bool + bool MkDir(Folder *self, String *path); /** List all local entries within a directory. Set the global error @@ -117,7 +117,7 @@ public abstract class Lucy::Store::Folder inherits Clownfish::Obj { * @param path A relative filepath. * @return true if `path` exists. */ - public bool + bool Exists(Folder *self, String *path); /** Indicate whether a directory exists at `path`. @@ -133,7 +133,7 @@ public abstract class Lucy::Store::Folder inherits Clownfish::Obj { * @param path A relative filepath. * @return true if the deletion was successful. */ - public bool + bool Delete(Folder *self, String *path); /** Delete recursively, starting at `path` @@ -142,7 +142,7 @@ public abstract class Lucy::Store::Folder inherits Clownfish::Obj { * @return true if the whole tree is deleted successfully, false if any * part remains. */ - public bool + bool Delete_Tree(Folder *self, String *path); /** Rename a file or directory, or set the global error object returned by @@ -153,7 +153,7 @@ public abstract class Lucy::Store::Folder inherits Clownfish::Obj { * @param to The filepath after renaming. * @return true on success, false on failure. */ - public abstract bool + abstract bool Rename(Folder *self, String *from, String *to); /** Create a hard link at path `to` pointing at the existing @@ -162,7 +162,7 @@ public abstract class Lucy::Store::Folder inherits Clownfish::Obj { * * @return true on success, false on failure. */ - public abstract bool + abstract bool Hard_Link(Folder *self, String *from, String *to); /** Read a file and return its contents. @@ -170,7 +170,7 @@ public abstract class Lucy::Store::Folder inherits Clownfish::Obj { * @param path A relative filepath. * @param return the file's contents. */ - public incremented Blob* + incremented Blob* Slurp_File(Folder *self, String *path); /** Collapse the contents of the directory into a compound file. @@ -202,19 +202,19 @@ public abstract class Lucy::Store::Folder inherits Clownfish::Obj { /** Perform implementation-specific initialization. For example: FSFolder * creates its own directory. */ - public abstract void + abstract void Initialize(Folder *self); /** Verify that operations may be performed on this Folder. * * @return true on success. */ - public abstract bool + abstract bool Check(Folder *self); /** Close the folder and release implementation-specific resources. */ - public abstract void + abstract void Close(Folder *self); /** Open a FileHandle for a local file, or set the global error object http://git-wip-us.apache.org/repos/asf/lucy/blob/920a7dd8/core/Lucy/Store/RAMFolder.cfh ---------------------------------------------------------------------- diff --git a/core/Lucy/Store/RAMFolder.cfh b/core/Lucy/Store/RAMFolder.cfh index c3e5964..909b70a 100644 --- a/core/Lucy/Store/RAMFolder.cfh +++ b/core/Lucy/Store/RAMFolder.cfh @@ -33,13 +33,13 @@ public class Lucy::Store::RAMFolder inherits Lucy::Store::Folder { public inert RAMFolder* init(RAMFolder *self, String *path = NULL); - public void + void Initialize(RAMFolder *self); - public bool + bool Check(RAMFolder *self); - public void + void Close(RAMFolder *self); incremented nullable FileHandle* @@ -63,10 +63,10 @@ public class Lucy::Store::RAMFolder inherits Lucy::Store::Folder { bool Local_Delete(RAMFolder *self, String *name); - public bool + bool Rename(RAMFolder *self, String* from, String *to); - public bool + bool Hard_Link(RAMFolder *self, String *from, String *to); } http://git-wip-us.apache.org/repos/asf/lucy/blob/920a7dd8/perl/buildlib/Lucy/Build/Binding/Store.pm ---------------------------------------------------------------------- diff --git a/perl/buildlib/Lucy/Build/Binding/Store.pm b/perl/buildlib/Lucy/Build/Binding/Store.pm index 20183c7..a02ab2a 100644 --- a/perl/buildlib/Lucy/Build/Binding/Store.pm +++ b/perl/buildlib/Lucy/Build/Binding/Store.pm @@ -214,14 +214,6 @@ END_XS_CODE } sub bind_lock { - my @exposed = qw( - Obtain - Request - Release - Is_Locked - Clear_Stale - ); - my $pod_spec = Clownfish::CFC::Binding::Perl::Pod->new; my $synopsis = <<'END_SYNOPSIS'; my $lock = $lock_factory->make_lock( @@ -243,7 +235,6 @@ END_SYNOPSIS END_CONSTRUCTOR $pod_spec->set_synopsis($synopsis); $pod_spec->add_constructor( alias => 'new', sample => $constructor, ); - $pod_spec->add_method( method => $_, alias => lc($_) ) for @exposed; my $binding = Clownfish::CFC::Binding::Perl::Class->new( parcel => "Lucy", @@ -283,11 +274,6 @@ END_SYNOPSIS } sub bind_lockfactory { - my @exposed = qw( - Make_Lock - Make_Shared_Lock - ); - my $pod_spec = Clownfish::CFC::Binding::Perl::Pod->new; my $synopsis = <<'END_SYNOPSIS'; use Sys::Hostname qw( hostname ); @@ -313,7 +299,6 @@ END_SYNOPSIS END_CONSTRUCTOR $pod_spec->set_synopsis($synopsis); $pod_spec->add_constructor( alias => 'new', sample => $constructor, ); - $pod_spec->add_method( method => $_, alias => lc($_) ) for @exposed; my $binding = Clownfish::CFC::Binding::Perl::Class->new( parcel => "Lucy",
