PLearn 0.1
ShellScript.cc
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // ShellScript.cc
00004 //
00005 // Copyright (C) 2004 Olivier Delalleau 
00006 // 
00007 // Redistribution and use in source and binary forms, with or without
00008 // modification, are permitted provided that the following conditions are met:
00009 // 
00010 //  1. Redistributions of source code must retain the above copyright
00011 //     notice, this list of conditions and the following disclaimer.
00012 // 
00013 //  2. Redistributions in binary form must reproduce the above copyright
00014 //     notice, this list of conditions and the following disclaimer in the
00015 //     documentation and/or other materials provided with the distribution.
00016 // 
00017 //  3. The name of the authors may not be used to endorse or promote
00018 //     products derived from this software without specific prior written
00019 //     permission.
00020 // 
00021 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00022 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00023 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00024 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00025 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00026 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00027 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00028 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00029 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00030 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00031 // 
00032 // This file is part of the PLearn library. For more information on the PLearn
00033 // library, go to the PLearn Web site at www.plearn.org
00034 
00035 /* *******************************************************      
00036  * $Id: ShellScript.cc 3994 2005-08-25 13:35:03Z chapados $ 
00037  ******************************************************* */
00038 
00039 // Authors: Olivier Delalleau
00040 
00044 #include "ShellScript.h"
00045 
00046 namespace PLearn {
00047 using namespace std;
00048 
00049 ShellScript::ShellScript() 
00050     /* ### Initialize all fields to their default value */
00051 {
00052     // ...
00053 
00054     // ### You may or may not want to call build_() to finish building the object
00055     // build_();
00056 }
00057 
00058 PLEARN_IMPLEMENT_OBJECT(ShellScript,
00059                         "Allows one to run shell commands (especially within a script).",
00060                         "This runnable object will execute the given shell commands when run.");
00061 
00062 void ShellScript::declareOptions(OptionList& ol)
00063 {
00064     // ### Declare all of this object's options here
00065     // ### For the "flags" of each option, you should typically specify  
00066     // ### one of OptionBase::buildoption, OptionBase::learntoption or 
00067     // ### OptionBase::tuningoption. Another possible flag to be combined with
00068     // ### is OptionBase::nosave
00069 
00070     declareOption(ol, "shell_commands", &ShellScript::shell_commands, OptionBase::buildoption,
00071                   "The commands to be executed at run time.");
00072 
00073     // Now call the parent class' declareOptions
00074     inherited::declareOptions(ol);
00075 }
00076 
00077 void ShellScript::build_()
00078 {
00079     // ### This method should do the real building of the object,
00080     // ### according to set 'options', in *any* situation. 
00081     // ### Typical situations include:
00082     // ###  - Initial building of an object from a few user-specified options
00083     // ###  - Building of a "reloaded" object: i.e. from the complete set of all serialised options.
00084     // ###  - Updating or "re-building" of an object after a few "tuning" options have been modified.
00085     // ### You should assume that the parent class' build_() has already been called.
00086 }
00087 
00088 // ### Nothing to add here, simply calls build_
00089 void ShellScript::build()
00090 {
00091     inherited::build();
00092     build_();
00093 }
00094 
00095 void ShellScript::makeDeepCopyFromShallowCopy(CopiesMap& copies)
00096 {
00097     inherited::makeDeepCopyFromShallowCopy(copies);
00098     deepCopyField(shell_commands, copies);
00099 }
00100 
00102 // run //
00104 void ShellScript::run() {
00105     // Perform the commands provided in shell_commands.
00106     for (int i = 0; i < shell_commands.length(); i++) {
00107         system(shell_commands[i].c_str());
00108     }
00109 }
00110 
00111 } // end of namespace PLearn
00112 
00113 
00114 /*
00115   Local Variables:
00116   mode:c++
00117   c-basic-offset:4
00118   c-file-style:"stroustrup"
00119   c-file-offsets:((innamespace . 0)(inline-open . 0))
00120   indent-tabs-mode:nil
00121   fill-column:79
00122   End:
00123 */
00124 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines