Changeset 9580

Timestamp:

12/09/09 17:18:04 (2 years ago)

Author:

adamk

Message:

I'm sick and tired of not having a simple slurp function available for Padre internals, so I've added one

File:

• trunk/Padre/lib/Padre/Util.pm (modified) (1 diff)

trunk/Padre/lib/Padre/Util.pm

@@ -74 +74 @@
 #####################################################################
 # Miscellaneous Functions
+
+=pod
+
+=head2 C<slurp>
+
+    my $content = Padre::Util::slurp( $file );
+    if ( $content ) {
+        print $$content;
+    } else {
+        # Handle errors appropriately
+    }
+
+This is a simple slurp implementation, provided as a convenience for
+internal Padre use when loading trivial unimportant files for which
+we don't need anything more robust.
+
+All file reading is done with binmode enabled, and data is returned by
+reference to avoid needless copying.
+
+Returns the content of the file as a SCALAR reference if the file exists
+and can be read.
+
+Returns false if loading of the file failed.
+
+This function is only expected to be used in situations where the file
+should almost always exist, and thus the reason why reading the file
+failed isn't really important.
+
+=cut
+
+sub slurp {
+    my $file = shift;
+    open my $fh, '<', $file or return '';
+    binmode $fh;
+    local $/ = undef;
+    my $content = <$fh>;
+    close $fh;
+    return \$content;
+}
 
 =pod