PEBLStream Namespace Reference

Functions
Variant	Print (Variant v)
	This prints the argument with a newline character.
Variant	Print_ (Variant v)
	This prints the argument without a linebreak at the end.
Variant	Format (Variant v)
Variant	FileOpenRead (Variant v)
	This opens a filestream for reading.
Variant	FileOpenWrite (Variant v)
	This opens a filestream for writing.
Variant	FileOpenOverwrite (Variant v)
	This opens a filestream for writing, replacing current file, without making a backup.
Variant	FileOpenAppend (Variant v)
	This opens a filestream for writing, appending to end of file.
Variant	FileClose (Variant v)
	This Closes a filestream.
Variant	FilePrint (Variant v)
	This prints contents of variant to file, followed by a newline.
Variant	FilePrint_ (Variant v)
	This prints contents of variant to file, without appending a newline.
Variant	FileReadCharacter (Variant v)
	Reads a character from a file.
Variant	FileReadWord (Variant v)
Variant	FileReadLine (Variant v)
	Reads until the next line.
Variant	FileReadList (Variant v)
	Places all words in file into a list.
Variant	FileReadTable (Variant v)
	Makes a list of lists, with each row contained in a list.
Variant	FileReadText (Variant v)
	This will read all of the text in a file into a single variant.
Variant	EndOfLine (Variant v)
	This detects if you are at the end of a line.
Variant	EndOfFile (Variant v)
	This detects if you are at the end of a file.
Variant	AppendFile (Variant v)
Variant	CopyFile (Variant v)
Variant	ConnectToIP (Variant v)
Variant	ConnectToHost (Variant v)
Variant	SetNetworkPort (Variant v)
Variant	CheckForNetworkConnection (Variant v)
Variant	OpenNetworkListener (Variant v)
Variant	AcceptNetworkConnection (Variant v)
Variant	WaitForNetworkConnection (Variant v)
Variant	CloseNetworkConnection (Variant v)
Variant	SendData (Variant v)
Variant	GetData (Variant v)
Variant	GetIPAddress (Variant v)
Variant	GetMyIPAddress (Variant v)
Variant	GetHTTPFile (Variant v)
Variant	GetHTTPText (Variant v)
Variant	PostHTTP (Variant v)
Variant	PostHTTPFile (Variant v)
Variant	MD5Sum (Variant v)
Variant	MD5File (Variant v)
Variant	WritePNG (Variant v)
Variant	ParseJSON (Variant v)

Variables
PEBL_Function_Type	FunctionTable []

Function Documentation

AcceptNetworkConnection()

Variant PEBLStream::AcceptNetworkConnection

(

Variant

v

)

Definition at line 1018 of file PEBLStream.cpp.

{
    return Variant(0);
}

AppendFile()

Variant PEBLStream::AppendFile

(

Variant

v

)

Definition at line 581 of file PEBLStream.cpp.

{
    //v[1] should have the filename
    PList * plist = v.GetComplexData()->GetList();
    Variant v1 = plist->First(); //plist->PopFront();
    PError::AssertType(v1, PEAT_STRING, "Argument error in function [AppendFile(<file1>,<file2>)]:  ");
 
    string filename1 = v1.GetString();
 
 
    Variant v2 = plist->Nth(2);
    PError::AssertType(v2, PEAT_STRING, "Argument error in function [AppendFile(<file1>,<file2>)]:  ");
 
    //Search through the paths for the file, because it may be a 'special' file.
    string filename2 = Evaluator::gPath.FindFile(v2.GetString());
 
    if(filename2 == "")
        PError::SignalFatalError(string("Unable to find file [")  + v2.GetString() + string("] in AppendFile"));
 
    //open files in binary mode so we can do a direct copy.
 
    std::ifstream in(filename2.c_str(), ios_base::in|ios_base::binary);
    std::ofstream out(filename1.c_str(), ios_base::out|ios_base::app|ios_base::binary);
 
 
    if(!in.is_open())
        {
            PError::SignalWarning("Unable to open file ["+filename2+"]. No data copied.");
        }
    if(!out.is_open())
        {
            PError::SignalFatalError("Unable to open file ["+filename1+"]. Check permissions or determine whether directory exists.");
        }
 
 
    char buf[BSIZE];
    do {
        in.read(&buf[0],BSIZE);
        out.write(&buf[0],in.gcount());
    }while (in.gcount()>0);
 
    in.close();
    out.close();
    return Variant(1);
}

References PError::AssertType(), PEBLPath::FindFile(), PList::First(), Variant::GetComplexData(), PComplexData::GetList(), Variant::GetString(), Evaluator::gPath, PList::Nth(), PEAT_STRING, PError::SignalFatalError(), and PError::SignalWarning().

CheckForNetworkConnection()

Variant PEBLStream::CheckForNetworkConnection

(

Variant

v

)

Definition at line 1007 of file PEBLStream.cpp.

{
    return Variant(0);
}

CloseNetworkConnection()

Variant PEBLStream::CloseNetworkConnection

(

Variant

v

)

Definition at line 1029 of file PEBLStream.cpp.

{
    // Silently succeed - nothing to close
    return Variant(1);
}

ConnectToHost()

Variant PEBLStream::ConnectToHost

(

Variant

v

)

Definition at line 995 of file PEBLStream.cpp.

{
    PError::SignalWarning("Network support not compiled in. ConnectToHost returning 0 (failed).");
    return Variant(0);
}

References PError::SignalWarning().

ConnectToIP()

Variant PEBLStream::ConnectToIP

(

Variant

v

)

Definition at line 989 of file PEBLStream.cpp.

{
    PError::SignalWarning("Network support not compiled in. ConnectToIP returning 0 (failed).");
    return Variant(0);
}

References PError::SignalWarning().

CopyFile()

Variant PEBLStream::CopyFile

(

Variant

v

)

Definition at line 632 of file PEBLStream.cpp.

{
    //v[1] should have the filename
    PList * plist = v.GetComplexData()->GetList();
    Variant v1 = plist->First(); //plist->PopFront();
    PError::AssertType(v1, PEAT_STRING, "Argument error in function [CopyFile(<sourcefile>,<destfile>)]:  ");
 
 
    string srcfile = Evaluator::gPath.FindFile(v1.GetString());
    if(srcfile == "")
        PError::SignalFatalError(string("Unable to find file [")  + v1.GetString() + string("] in CopyFile"));
 
 
 
    Variant v2 = plist->Nth(2);
    PError::AssertType(v2, PEAT_STRING, "Argument error in function [CopyFile(<sourcefile>,<destfile>)]:  ");
 
 
    string destfile = v1.GetString();
 
 
    //open files in binary mode so we can do a direct copy.
 
    std::ifstream in(srcfile.c_str(), ios_base::in|ios_base::binary);
    std::ofstream out(destfile.c_str(), ios_base::out|ios_base::binary);
 
 
    if(!in.is_open())
        {
            PError::SignalWarning("Unable to open file ["+srcfile+"]. File not copied.");
        }
    if(!out.is_open())
        {
            PError::SignalFatalError("Unable to open file ["+destfile+"]. Check permissions or determine whether directory exists.");
        }
 
 
    char buf[BSIZE];
    do {
        in.read(&buf[0],BSIZE);
        out.write(&buf[0],in.gcount());
    }while (in.gcount()>0);
 
    in.close();
    out.close();
    return Variant(1);
}

References PError::AssertType(), PEBLPath::FindFile(), PList::First(), Variant::GetComplexData(), PComplexData::GetList(), Variant::GetString(), Evaluator::gPath, PList::Nth(), PEAT_STRING, PError::SignalFatalError(), and PError::SignalWarning().

EndOfFile()

Variant PEBLStream::EndOfFile

(

Variant

v

)

This detects if you are at the end of a file.

Definition at line 567 of file PEBLStream.cpp.

{
   //v[1] should have the file stream
    PList * plist = v.GetComplexData()->GetList();
    Variant v1 = plist->First(); //plist->PopFront();
 
    PError::AssertType(v1, PEAT_FILESTREAM, "Argument error in function [EndOfFile(<file-stream>)]: ");
    counted_ptr<PEBLObjectBase> tmp2 = (v1.GetComplexData())->GetObject();
    PStream * mystream = dynamic_cast<PStream*>(tmp2.get());
    return Variant(mystream->Eof());
}

References PError::AssertType(), PStream::Eof(), PList::First(), counted_ptr< X >::get(), Variant::GetComplexData(), PComplexData::GetList(), and PEAT_FILESTREAM.

EndOfLine()

Variant PEBLStream::EndOfLine

(

Variant

v

)

This detects if you are at the end of a line.

Definition at line 553 of file PEBLStream.cpp.

{
   //v[1] should have the file stream
    PList * plist = v.GetComplexData()->GetList();
    Variant v1 = plist->First(); //plist->PopFront();
 
    PError::AssertType(v1, PEAT_FILESTREAM, "Argument error in function [EndOfLine(<file-stream>)]: ");
    counted_ptr<PEBLObjectBase> tmp2 = (v1.GetComplexData())->GetObject();
    PStream * mystream = dynamic_cast<PStream*>(tmp2.get());
    return Variant(mystream->Eol());
}

References PError::AssertType(), PStream::Eol(), PList::First(), counted_ptr< X >::get(), Variant::GetComplexData(), PComplexData::GetList(), and PEAT_FILESTREAM.

FileClose()

Variant PEBLStream::FileClose

(

Variant

v

)

This Closes a filestream.

This is a filestream.

Definition at line 285 of file PEBLStream.cpp.

{
    //v[1] should have the file stream to close
    PList * plist = v.GetComplexData()->GetList();
 
    Variant v1 = plist->First();// plist->PopFront();
    PError::AssertType(v1, PEAT_FILESTREAM, "Argument error in function [FileClose(<file-stream>)]: ");
 
 
    counted_ptr<PEBLObjectBase> tmp2 = (v1.GetComplexData())->GetObject();
    PStream * mystream = dynamic_cast<PStream*>(tmp2.get());
    return Variant(mystream->Close());
}

References PError::AssertType(), PStream::Close(), PList::First(), counted_ptr< X >::get(), Variant::GetComplexData(), PComplexData::GetList(), and PEAT_FILESTREAM.

FileOpenAppend()

Variant PEBLStream::FileOpenAppend

(

Variant

v

)

This opens a filestream for writing, appending to end of file.

v1 contains the name of a file to open.

Definition at line 263 of file PEBLStream.cpp.

{
    PList * plist = v.GetComplexData()->GetList();
    Variant v1 = plist->First(); //plist->PopFront();
    PError::AssertType(v1, PEAT_STRING, "Argument error in function FileOpenAppend(<string>)]: ");
 
 
    counted_ptr<PEBLObjectBase> mystream = counted_ptr<PEBLObjectBase>(new PStream(v1,sdAppend, stASCII));
    mystream->SetProperty("FILENAME",v1);
    mystream->SetProperty("DIRECTION","WRITE");
 
    PComplexData * pcd = new PComplexData(mystream);
    Variant tmp = Variant(pcd);
    delete pcd;
    pcd=NULL;
    return tmp;
 
 
}

References PError::AssertType(), PList::First(), Variant::GetComplexData(), PComplexData::GetList(), NULL, PEAT_STRING, sdAppend, and stASCII.

FileOpenOverwrite()

Variant PEBLStream::FileOpenOverwrite

(

Variant

v

)

This opens a filestream for writing, replacing current file, without making a backup.

v1 contains the name of a file to open.

Definition at line 234 of file PEBLStream.cpp.

{
 
 
    // should be able to create the directory if it doesn't exist.
    //    char sysText[256];
    //    sprintf( systext, "mkdir -p %s", path ); // path is a char * to the string representing the directory you want to create
    //    system( systext );
 
 
    PList * plist = v.GetComplexData()->GetList();
    Variant v1 = plist->First(); //plist->PopFront();
    PError::AssertType(v1, PEAT_STRING, "Argument error in function FileOpenOverWrite(<string>)]: ");
 
    counted_ptr<PEBLObjectBase> mystream = counted_ptr<PEBLObjectBase>(new PStream(v1,sdWrite, stASCII));
    mystream->SetProperty("FILENAME",v1);
    mystream->SetProperty("DIRECTION","WRITE");
 
    PComplexData * pcd = new PComplexData(mystream);
    Variant tmp = Variant(pcd);
    delete pcd;
    pcd=NULL;
    return tmp;
 
}

References PError::AssertType(), PList::First(), Variant::GetComplexData(), PComplexData::GetList(), NULL, PEAT_STRING, sdWrite, and stASCII.

FileOpenRead()

Variant PEBLStream::FileOpenRead

(

Variant

v

)

This opens a filestream for reading.

v1 contains the name of a file to open.

Definition at line 149 of file PEBLStream.cpp.

{
    PList * plist = v.GetComplexData()->GetList();
    Variant v1 = plist->First();// plist->PopFront();
    PError::AssertType(v1, PEAT_STRING, "Argument error in function FileOpenRead(<string>)]: ");
 
    counted_ptr<PEBLObjectBase> mystream = counted_ptr<PEBLObjectBase>(new PStream(v1,sdRead, stASCII));
    mystream->SetProperty("FILENAME",v1);
    mystream->SetProperty("DIRECTION","READ");
    PComplexData * pcd = new PComplexData(mystream);
    Variant tmp = Variant(pcd);
    delete pcd;
    pcd=NULL;
    return tmp;
}

References PError::AssertType(), PList::First(), Variant::GetComplexData(), PComplexData::GetList(), NULL, PEAT_STRING, sdRead, and stASCII.

FileOpenWrite()

Variant PEBLStream::FileOpenWrite

(

Variant

v

)

This opens a filestream for writing.

This opens a filestream for writing, replacing current file.

v1 contains the name of a file to open.

Definition at line 167 of file PEBLStream.cpp.

{
 
 
    // should be able to create the directory if it doesn't exist.
    //    char sysText[256];
    //    sprintf( systext, "mkdir -p %s", path ); // path is a char * to the string representing the directory you want to create
    //    system( systext );
 
 
    PList * plist = v.GetComplexData()->GetList();
    Variant v1 = plist->First(); //plist->PopFront();
    PError::AssertType(v1, PEAT_STRING, "Argument error in function FileOpenWrite(<string>)]: ");
 
    Variant out = PEBLUtility::FileExists(v1);
    Variant v11=Variant(v1);
    if(out)
        {
            // The file exists, so let's do some text munching and
            // create a new filename to use.
            std::string fname =  (v1);
            size_t i = fname.rfind(".");
            std::string base, ext;
            if(i != 0)
                {
                    base = fname.substr(0,i);
                    ext = fname.substr(i+1,fname.length());
                }
            else
                {
                    //No . found
                    base = fname;
                    ext = "";
                }
            //See if the last character of base is numeric
            int version =  base[base.length()];
            if(version>0)
                {
                    base = base.substr(0,base.length()-1);
                }
 
            v11= Variant(base) + Variant(version) + Variant(".")+Variant(ext);
            while( PEBLUtility::FileExists(v11))
                {
 
                    v11 = Variant(base) + Variant(version++) + Variant(".")+Variant(ext);
 
                     }
 
           PError::SignalWarning(Variant("File [") + v1 + Variant("] already exists.  Using [")+ v11 + Variant("] instead"));
        }
    counted_ptr<PEBLObjectBase> mystream = counted_ptr<PEBLObjectBase>(new PStream(v11,sdWrite, stASCII));
    mystream->SetProperty("FILENAME",v11);
    mystream->SetProperty("DIRECTION","WRITE");
    PComplexData * pcd = new PComplexData(mystream);
    Variant tmp = Variant(pcd);
    delete pcd;
    pcd=NULL;
    return tmp;
 
}

References PError::AssertType(), PEBLUtility::FileExists(), PList::First(), Variant::GetComplexData(), PComplexData::GetList(), NULL, PEAT_STRING, sdWrite, PError::SignalWarning(), and stASCII.

FilePrint()

Variant PEBLStream::FilePrint

(

Variant

v

)

This prints contents of variant to file, followed by a newline.

Definition at line 300 of file PEBLStream.cpp.

{
    //v[1] should have the file stream
    //v[2] should have the variant to print
    PList * plist = v.GetComplexData()->GetList();
 
    Variant v1 = plist->First(); //plist->PopFront();
 
 
    PError::AssertType(v1, PEAT_FILESTREAM, "Argument error in first parameter of function [FilePrint(<file-stream>, <text>)]: ");
 
    counted_ptr<PEBLObjectBase> tmp2 = (v1.GetComplexData())->GetObject();
    PStream * mystream = dynamic_cast<PStream*>(tmp2.get());
 
 
    Variant v2 = plist->Nth(2); //plist->PopFront();
    std::string s = v2.GetString();
 
    mystream->WriteString(s + "\n");
    return (v2+Variant("\n"));
}

References PError::AssertType(), PList::First(), counted_ptr< X >::get(), Variant::GetComplexData(), PComplexData::GetList(), Variant::GetString(), PList::Nth(), PEAT_FILESTREAM, and PStream::WriteString().

FilePrint_()

Variant PEBLStream::FilePrint_

(

Variant

v

)

This prints contents of variant to file, without appending a newline.

Definition at line 322 of file PEBLStream.cpp.

{
    //v[1] should have the file stream
    //v[2] should have the variant to print
    PList * plist = v.GetComplexData()->GetList();
 
    Variant v1 = plist->First(); //plist->PopFront();
 
    PError::AssertType(v1, PEAT_FILESTREAM, "Argument error in first parameter of function [FilePrint_(<file-stream>, <text>)]: ");
 
    counted_ptr<PEBLObjectBase> tmp2 = (v1.GetComplexData())->GetObject();
    PStream * mystream = dynamic_cast<PStream*>(tmp2.get());
 
    Variant v2 = plist->Nth(2); //plist->PopFront();
    mystream->WriteString(v2);
    return v2;
}

References PError::AssertType(), PList::First(), counted_ptr< X >::get(), Variant::GetComplexData(), PComplexData::GetList(), PList::Nth(), PEAT_FILESTREAM, and PStream::WriteString().

FileReadCharacter()

Variant PEBLStream::FileReadCharacter

(

Variant

v

)

Reads a character from a file.

Definition at line 340 of file PEBLStream.cpp.

{
    //v[1] should have the file stream
    PList * plist = v.GetComplexData()->GetList();
 
    Variant v1 = plist->First(); //plist->PopFront();
 
    PError::AssertType(v1, PEAT_FILESTREAM, "Argument error in function [FileReadCharacter(<file-stream>)]: ");
    counted_ptr<PEBLObjectBase> tmp2 = (v1.GetComplexData())->GetObject();
 
    PStream * mystream = dynamic_cast<PStream*>(tmp2.get());
    char c = (mystream->ReadChar());
    return Variant((char)c);
}

References PError::AssertType(), PList::First(), counted_ptr< X >::get(), Variant::GetComplexData(), PComplexData::GetList(), PEAT_FILESTREAM, and PStream::ReadChar().

FileReadLine()

Variant PEBLStream::FileReadLine

(

Variant

v

)

Reads until the next line.

Definition at line 372 of file PEBLStream.cpp.

{
    PList * plist = v.GetComplexData()->GetList();
    //v[1] should have the file stream
    Variant v1 = plist->First();// plist->PopFront();
 
    PError::AssertType(v1, PEAT_FILESTREAM, "Argument error in function [FileReadLine(<file-stream>)]: ");
    counted_ptr<PEBLObjectBase> tmp2 = (v1.GetComplexData())->GetObject();
    PStream * mystream = dynamic_cast<PStream*>(tmp2.get());
 
    return Variant(mystream->ReadLineClean());
}

References PError::AssertType(), PList::First(), counted_ptr< X >::get(), Variant::GetComplexData(), PComplexData::GetList(), PEAT_FILESTREAM, and PStream::ReadLineClean().

FileReadList()

Variant PEBLStream::FileReadList

(

Variant

v

)

Places all words in file into a list.

This function takes a filename as an argument. It Opens the file, and reads in each line of the file into a string, which it places in a list that it returns. It closes the file afterward.

Definition at line 391 of file PEBLStream.cpp.

{
 
   //v[1] should have the filename
    PList * plist = v.GetComplexData()->GetList();
 
    Variant v1 = plist->First(); //plist->PopFront();
    PError::AssertType(v1, PEAT_STRING, "Argument error in function [FileReadList(<filename>)]:  ");
 
    //Search through the paths for the file, because it may be a 'special' file.
    string filename = Evaluator::gPath.FindFile(v1.GetString());
 
    if(filename == "")
        PError::SignalFatalError(string("Unable to find file [")  + v1.GetString() + string("]."));
 
    //It must be good, so open it.
    PStream *  mystream = new PStream(filename,sdRead, stASCII);
 
 
 
    PList * returnlist = new PList();
    std::string  tmpstring;
    while(!mystream->Eof())
        {
            tmpstring = mystream->ReadLineClean();
 
            if(strcmp("",tmpstring.c_str()) &&       //Ignore blank lines
               strncmp("#",tmpstring.c_str(),1)      //Ignore lines starting with #
               )
                {
                    returnlist->PushBack(tmpstring);
                }
        }
    mystream->Close();
    delete mystream;
 
    counted_ptr<PEBLObjectBase>  tmp2 = counted_ptr<PEBLObjectBase>(returnlist);
    PComplexData * pcd = new PComplexData(tmp2);
    Variant tmp3 = Variant(pcd);
    delete pcd;
    pcd=NULL;
    return tmp3;
}

References PError::AssertType(), PStream::Close(), PStream::Eof(), PEBLPath::FindFile(), PList::First(), Variant::GetComplexData(), PComplexData::GetList(), Variant::GetString(), Evaluator::gPath, NULL, PEAT_STRING, PList::PushBack(), PStream::ReadLineClean(), sdRead, PError::SignalFatalError(), and stASCII.

FileReadTable()

Variant PEBLStream::FileReadTable

(

Variant

v

)

Makes a list of lists, with each row contained in a list.

Give this function a filename, and it will read it into a list of lists; each line is a list, and the (optional) token-separated elements are the items of the list.

Definition at line 439 of file PEBLStream.cpp.

{
    //v[1] should have the file stream
    PList * plist = v.GetComplexData()->GetList();
    Variant v1 = plist->First(); //plist->PopFront();
    PError::AssertType(v1, PEAT_STRING, "Argument error in first parameter of function [FileReadTable(<list>,opt:<sep>)]:  ");
 
    //Search through the paths for the file, because it may be a 'special' file.
    string filename = Evaluator::gPath.FindFile(v1.GetString());
 
    if(filename == "")
        PError::SignalFatalError(string("Unable to find file [")  +v1.GetString() + string("]."));
 
    //It must be good, so open it.
    PStream *   myStream = new PStream(filename,sdRead, stASCII);
 
    char separator;
    //See if there is another parameter; if there is, it is the token separator.
    if(plist->Length()>1)
        {
            PError::AssertType(plist->Nth(2), PEAT_STRING, "Argument error in second parameter of function [FileReadTable(<list>,opt:<sep>)]:  ");
            std::string tmp = plist->Nth(2);
            separator = tmp[0];
 
        }
    else
        {
            separator = ' ';
        }
 
    //Make an outer list to put everything in.
 
    PList * returnlist = new PList();
 
    //Make an inner list
    Variant innerlist;
 
    std::string tmpstring;
 
    while(!myStream->Eof())
        {
 
            tmpstring = myStream->ReadLineClean();
            if((strcmp("",tmpstring.c_str()) == 0) ||      //Ignore blank lines
               (strncmp("#",tmpstring.c_str(),1)==0)      //Ignore lines starting with #
               )
                {
 
                    //This line is garbage, so read it and throw it away.
 
                }
            else
                {
                    innerlist =  PEBLUtility::Tokenize(tmpstring.c_str(),separator);
                    returnlist->PushBack(innerlist);
                }
        }
    myStream->Close();
    delete myStream;
    counted_ptr<PEBLObjectBase> tmp2 =  counted_ptr<PEBLObjectBase>(returnlist);
    PComplexData * pcd = new PComplexData(tmp2);
    Variant tmp3 = Variant(pcd);
    delete pcd;
    pcd=NULL;
    return tmp3;
 
}

References PError::AssertType(), PStream::Close(), PStream::Eof(), PEBLPath::FindFile(), PList::First(), Variant::GetComplexData(), PComplexData::GetList(), Variant::GetString(), Evaluator::gPath, PList::Length(), PList::Nth(), NULL, PEAT_STRING, PList::PushBack(), PStream::ReadLineClean(), sdRead, PError::SignalFatalError(), stASCII, and PEBLUtility::Tokenize().

FileReadText()

Variant PEBLStream::FileReadText

(

Variant

v

)

This will read all of the text in a file into a single variant.

This function takes a filename as an argument. It Opens the file, and reads in the entire file as a string, which it returns, and closes the file afterward. It ignores any lines that begin with #, and converts '
' to [10], which is later parsed as a carriage return.

Definition at line 513 of file PEBLStream.cpp.

{
 
   //v[1] should have the filename
    PList * plist = v.GetComplexData()->GetList();
    Variant v1 = plist->First(); //plist->PopFront();
    PError::AssertType(v1, PEAT_STRING, "Argument error in function [FileReadText(<filename>)]:  ");
 
    //Search through the paths for the file, because it may be a 'special' file.
    string filename = Evaluator::gPath.FindFile(v1.GetString());
 
    if(filename == "")
        PError::SignalFatalError(string("Unable to find file [")  + v1.GetString() + string("]."));
 
    //It must be good, so open it.
    PStream * mystream = new PStream(filename,sdRead, stASCII);
 
 
    Variant returnText = "";
    std::string tmpstring;
    while(!mystream->Eof())
        {
            tmpstring = mystream->ReadLine();
 
            if( strncmp("#",tmpstring.c_str(),1)      //Ignore lines starting with #
               )
                {
                    //This is wrong--it will add extra space where it is not needed.
                    returnText = returnText +  Variant(tmpstring);
                }
        }
    mystream->Close();
    delete mystream;
 
    return returnText;
}

References PError::AssertType(), PStream::Close(), PStream::Eof(), PEBLPath::FindFile(), PList::First(), Variant::GetComplexData(), PComplexData::GetList(), Variant::GetString(), Evaluator::gPath, PEAT_STRING, PStream::ReadLine(), sdRead, PError::SignalFatalError(), and stASCII.

FileReadWord()

Variant PEBLStream::FileReadWord

(

Variant

v

)

Reads everything up until the next space/newline, dropping all initial spaces/newlines

Definition at line 355 of file PEBLStream.cpp.

{
    //v[1] should have the file stream
    PList * plist = v.GetComplexData()->GetList();
 
    Variant v1 = plist->First(); //plist->PopFront();
 
    PError::AssertType(v1, PEAT_FILESTREAM, "Argument error in function [FileReadWord(<file-stream>)]: ");
 
    counted_ptr<PEBLObjectBase> tmp2 = (v1.GetComplexData())->GetObject();
    PStream * mystream = dynamic_cast<PStream*>(tmp2.get());
 
    return Variant(mystream->ReadToken(' '));
}

References PError::AssertType(), PList::First(), counted_ptr< X >::get(), Variant::GetComplexData(), PComplexData::GetList(), PEAT_FILESTREAM, and PStream::ReadToken().

Format()

Variant PEBLStream::Format

(

Variant

v

)

This operates like print but without the printing. Useless right now, but could be used for formatting output, changing numbers to text, etc.

Definition at line 138 of file PEBLStream.cpp.

{
 
    PList * plist = v.GetComplexData()->GetList();
    Variant v1 = plist->First();
    PError::SignalFatalError("Function [Format()] not implemented.");
    return v1;
}

References PList::First(), Variant::GetComplexData(), PComplexData::GetList(), and PError::SignalFatalError().

GetData()

Variant PEBLStream::GetData

(

Variant

v

)

Definition at line 1040 of file PEBLStream.cpp.

{
    return Variant("");
}

GetHTTPFile()

Variant PEBLStream::GetHTTPFile

(

Variant

v

)

Definition at line 1190 of file PEBLStream.cpp.

{
    // Return 503 Service Unavailable status code
    return Variant(503);
}

GetHTTPText()

Variant PEBLStream::GetHTTPText

(

Variant

v

)

Definition at line 1196 of file PEBLStream.cpp.

{
    // Return [503, ""] list (status code 503, empty text)
    PList * returnlist = new PList();
    returnlist->PushBack(Variant(503));
    returnlist->PushBack(Variant(""));
    counted_ptr<PEBLObjectBase>  tmp2 = counted_ptr<PEBLObjectBase>(returnlist);
    PComplexData * pcd = new PComplexData(tmp2);
    Variant tmp3 = Variant(pcd);
    delete pcd;
    pcd=NULL;
    return tmp3;
}

References NULL, and PList::PushBack().

GetIPAddress()

Variant PEBLStream::GetIPAddress

(

Variant

v

)

Definition at line 1045 of file PEBLStream.cpp.

{
    return Variant("0.0.0.0");
}

GetMyIPAddress()

Variant PEBLStream::GetMyIPAddress

(

Variant

v

)

Definition at line 1050 of file PEBLStream.cpp.

{
    return Variant("0.0.0.0");
}

MD5File()

Variant PEBLStream::MD5File

(

Variant

v

)

Definition at line 1235 of file PEBLStream.cpp.

{
    PList * plist = v.GetComplexData()->GetList();
    Variant v1 = plist->First();// plist->PopFront();
    PError::AssertType(v1, PEAT_STRING, "Argument error in first parameter of function [MD5File(<fname>)]:");
    std::string sum = PEBLUtility::MD5File(v1);
    return Variant(sum);
}

References PError::AssertType(), PList::First(), Variant::GetComplexData(), PComplexData::GetList(), PEBLUtility::MD5File(), and PEAT_STRING.

MD5Sum()

Variant PEBLStream::MD5Sum

(

Variant

v

)

Definition at line 1225 of file PEBLStream.cpp.

{
    PList * plist = v.GetComplexData()->GetList();
    Variant v1 = plist->First();// plist->PopFront();
    PError::AssertType(v1, PEAT_STRING, "Argument error in first parameter of function [MD5Sum(<text>)]:");
    std::string sum = PEBLUtility::MD5String(v1);
    return Variant(sum);
}

References PError::AssertType(), PList::First(), Variant::GetComplexData(), PComplexData::GetList(), PEBLUtility::MD5String(), and PEAT_STRING.

OpenNetworkListener()

Variant PEBLStream::OpenNetworkListener

(

Variant

v

)

Definition at line 1012 of file PEBLStream.cpp.

{
    PError::SignalWarning("Network support not compiled in. OpenNetworkListener returning 0 (failed).");
    return Variant(0);
}

References PError::SignalWarning().

ParseJSON()

Variant PEBLStream::ParseJSON

(

Variant

v

)

Definition at line 1323 of file PEBLStream.cpp.

{
    PList * plist = v.GetComplexData()->GetList();
    Variant v1 = plist->First(); 
    PError::AssertType(v1, PEAT_STRING, "Argument error in first parameter of function [ParseJSON(<json-text>)]: ");
 
    Variant out = PEBLUtility::ParseJSON(v1);
    return out;
}

References PError::AssertType(), PList::First(), Variant::GetComplexData(), PComplexData::GetList(), PEBLUtility::ParseJSON(), and PEAT_STRING.

PostHTTP()

Variant PEBLStream::PostHTTP

(

Variant

v

)

Definition at line 1210 of file PEBLStream.cpp.

{
    // Return 503 Service Unavailable
    return Variant(503);
}

PostHTTPFile()

Variant PEBLStream::PostHTTPFile

(

Variant

v

)

Definition at line 1216 of file PEBLStream.cpp.

{
    // Return 503 Service Unavailable
    return Variant(503);
}

Print()

Variant PEBLStream::Print

(

Variant

v

)

This prints the argument with a newline character.

Definition at line 115 of file PEBLStream.cpp.

{
 
    PList * plist = v.GetComplexData()->GetList();
    Variant v1 = plist->First();
    //No type assertion is needed, because everything should work.
    cout << v1 << endl;
 
    return v1;
}

References PList::First(), Variant::GetComplexData(), and PComplexData::GetList().

Print_()

Variant PEBLStream::Print_

(

Variant

v

)

This prints the argument without a linebreak at the end.

Definition at line 127 of file PEBLStream.cpp.

{
 
    PList * plist = v.GetComplexData()->GetList();
    Variant v1 = plist->First();
    //No type assertion is needed, because everything should work.
    cout << v1 << flush;
 
    return v1;
}

References PList::First(), Variant::GetComplexData(), and PComplexData::GetList().

SendData()

Variant PEBLStream::SendData

(

Variant

v

)

Definition at line 1035 of file PEBLStream.cpp.

{
    return Variant(0);
}

SetNetworkPort()

Variant PEBLStream::SetNetworkPort

(

Variant

v

)

Definition at line 1001 of file PEBLStream.cpp.

{
    PError::SignalWarning("Network support not compiled in. SetNetworkPort has no effect.");
    return Variant(0);
}

References PError::SignalWarning().

WaitForNetworkConnection()

Variant PEBLStream::WaitForNetworkConnection

(

Variant

v

)

Definition at line 1023 of file PEBLStream.cpp.

{
    PError::SignalWarning("Network support not compiled in. WaitForNetworkConnection returning 0 (failed).");
    return Variant(0);
}

References PError::SignalWarning().

WritePNG()

Variant PEBLStream::WritePNG

(

Variant

v

)

Definition at line 1245 of file PEBLStream.cpp.

{
    //v[1] should have an object/window name.
    //v[2] should have a filename
 
    PList * plist = v.GetComplexData()->GetList();
    Variant v1 = plist->First();// plist->PopFront();
    PError::AssertType(v1, PEAT_STRING, "Argument error in first parameter of function [WritePNG(<filename>,<object>,<range>)]: ");
 
 
    Variant v2 = plist->Nth(2);
    PError::AssertType(v2, PEAT_WINDOW, "Argument error in second parameter of function [WritePNG(<filename>,<object>,<range>)]: ");
    counted_ptr<PEBLObjectBase> tmp2 = (v2.GetComplexData())->GetObject();
 
 
    Variant v3 = plist->Nth(3);
 
 
    PError::AssertType(v3, PEAT_LIST, "Argument error in third parameter of function [WritePNG(<filename>,<object>,<range>)]: ");
    // counted_ptr<PEBLObjectBase> tmp3 = (range.GetComplexData())->GetObject();
 
    PList * range = (PList*)(v3.GetComplexData()->GetObject().get());
 
    
 
    PlatformWindow * myWin = dynamic_cast<PlatformWindow*>(tmp2.get());
 
    //range must have four numeric values
    //start off with entire window.
    int x=0;
    int y=0;
    int w = myWin->GetWidth();
    int h = myWin->GetHeight();
 
    //if third argument is properly formed, select the subrange
    long int length = range->Length();
    if(length == 4)
        {
            int newx=range->Nth(1);
            int newy=range->Nth(2);
            int neww=range->Nth(3);
            int newh=range->Nth(4);
 
            if(newx<0 || newx > myWin->GetWidth() ||
               newy < 0 || newy > myWin->GetHeight() ||
               neww < 0 || (neww + newx ) > myWin->GetWidth() ||
               newh < 0 || (newh + newy) > myWin->GetHeight())
                {
                    PError::SignalWarning("Screenshot bounds outside range of screen. Using entire screen");
                } else
                {
                    x = newx;
                    y = newy;
                    h = newh;
                    w = neww;
                        
                }
   
 
        }
 
    
    
 
    int result = myWin->SaveScreenShot(x,y,w,h,v1);
 
 
    if(result != 0)
        {
            PError::SignalWarning(Variant("Failed to write png file ") + v2);
        }
 
    return Variant(result);
}

References PError::AssertType(), PList::First(), counted_ptr< X >::get(), Variant::GetComplexData(), PlatformWindow::GetHeight(), PComplexData::GetList(), PComplexData::GetObject(), PlatformWindow::GetWidth(), PList::Length(), PList::Nth(), PEAT_LIST, PEAT_STRING, PEAT_WINDOW, PlatformWindow::SaveScreenShot(), and PError::SignalWarning().

Variable Documentation

FunctionTable

PEBL_Function_Type PEBLStream::FunctionTable[]

Definition at line 123 of file Functions.h.

        {
            {(char*)"PRINT",                Print,            1, 1},
            {(char*)"PRINT_",               Print_,           1, 1},
            {(char*)"FORMAT",               Format,           1, 1},
            {(char*)"FILEOPENREAD",         FileOpenRead,     1, 1},
            {(char*)"FILEOPENWRITE",        FileOpenWrite,    1, 1},
            {(char*)"FILEOPENOVERWRITE",    FileOpenOverwrite, 1,1},
            {(char*)"FILEOPENAPPEND",       FileOpenAppend,   1, 1},
            {(char*)"FILECLOSE",            FileClose,        1, 1},
            {(char*)"FILEPRINT",            FilePrint,        2, 2},
            {(char*)"FILEPRINT_",           FilePrint_,       2, 2},
            {(char*)"FILEREADCHARACTER",    FileReadCharacter,1, 1},
            {(char*)"FILEREADWORD",         FileReadWord,     1, 1},
            {(char*)"FILEREADLINE",         FileReadLine,     1, 1},
            {(char*)"FILEREADLIST",         FileReadList,     1, 1},
            {(char*)"FILEREADTABLE",        FileReadTable,    1, 2},
            {(char*)"FILEREADTEXT",         FileReadText,     1, 1},
 
            {(char*)"ENDOFLINE",            EndOfLine,        1, 1},
            {(char*)"ENDOFFILE",            EndOfFile,        1, 1},
            {(char*)"APPENDFILE",           AppendFile,       2, 2},
            {(char*)"COPYFILE",           CopyFile,       2, 2},
 
            // Network functions - now always available (stub implementations when PEBL_NETWORK not defined)
            {(char*)"CONNECTTOIP", ConnectToIP,               2, 2},
            {(char*)"CONNECTTOHOST", ConnectToHost,           2, 2},
 
            {(char*)"SETNETWORKPORT",           SetNetworkPort,               1, 1},
            {(char*)"CHECKFORNETWORKCONNECTION", CheckForNetworkConnection,   1, 1},
            {(char*)"OPENNETWORKLISTENER", OpenNetworkListener,   1, 1},
 
            {(char*)"ACCEPTNETWORKCONNECTION", AcceptNetworkConnection, 2,2},
            {(char*)"WAITFORNETWORKCONNECTION", WaitForNetworkConnection, 1,1},
            {(char*)"CLOSENETWORKCONNECTION", CloseNetworkConnection,    1,1},
 
            {(char*)"SENDDATA", SendData,                     2,2},
            {(char*)"GETDATA", GetData,                       2,2},
            {(char*)"GETMYIPADDRESS", GetMyIPAddress,         1,1},
 
            // HTTP functions - now always available (stub implementations when PEBL_HTTP not defined)
            {(char*)"GETHTTPFILE", GetHTTPFile,               4,4},
            {(char*)"GETHTTPTEXT", GetHTTPText,               3,3},
            {(char*)"POSTHTTP", PostHTTP,                     5,5},
            {(char*)"POSTHTTPFILE", PostHTTPFile,             6,6},
 
            {(char*)"MD5SUM", MD5Sum,                         1,1},
            {(char*)"MD5FILE", MD5File,                        1,1},
 
 
            {(char*)"WRITEPNG", WritePNG,                     3,3},
            {(char*)"PARSEJSON",   ParseJSON,       1,1},
 
            // LSL (Lab Streaming Layer) functions - now always available (stub implementations when PEBL_USE_LSL not defined)
            {(char*)"CREATELSLOUTLET", CreateLSLOutlet,       1,3},
            {(char*)"SENDLSLMARKER", SendLSLMarker,           1,1},
            {(char*)"CLOSELSLOUTLET", CloseLSLOutlet,         0,0},
            {(char*)"LSLHASCONSUMERS", LSLHasConsumers,       0,0},
            {(char*)"LSLLOCALCLOCK", LSLLocalClock,           0,0},
 
#ifdef PEBL_USEPORTS
            {(char*)"OPENPPORT",OpenPPort,                   1,1},
            {(char*)"SETPPORTSTATE",SetPPortState,           2,2},
            {(char*)"GETPPORTSTATE",GetPPortState,           1,1},
            {(char*)"SETPPORTMODE", SetPPortMode,           2,2},
 
            {(char*)"OPENCOMPORT",      OpenComPort,          2,3},
            {(char*)"COMPORTSENDBYTE",  ComPortSendByte,      2,2},
            {(char*)"COMPORTGETBYTE",   ComPortGetByte,       1,1},
 
 
#endif
 
 
            {0,            0,  0, 0}
        };

Referenced by Loader::LoadLibraryFunctions().