contrib/mul/mbl/mbl_parse_block.h
Go to the documentation of this file.
00001 #ifndef mbl_parse_block_h
00002 #define mbl_parse_block_h
00003 
00004 //:
00005 // \file
00006 // \author Ian Scott
00007 // \date  25-Feb-2003
00008 // \brief Load a block of text from a file.
00009 
00010 #include <vcl_istream.h>
00011 #include <vcl_string.h>
00012 
00013 //: Read a block of text from a stream.
00014 // This function will read through a stream, and store the text found to a string.
00015 // The function terminates when it finds the closing brace.
00016 //
00017 // The stream's fail bit will be set on error. Comment lines beginning with //
00018 // will be ignored.
00019 // \param open_already should be true if the client has already
00020 // read the opening brace.
00021 // \return the text. The first and last characters are guaranteed to be
00022 // the opening and closing braces.
00023 vcl_string mbl_parse_block(vcl_istream &afs, bool open_already = false, const char * comment = "//");
00024 #endif // mbl_parse_block_h